README
1gnome-getting-started-docs
2==========================
3
4This package contains the Getting Started guide which is packaged and
5shipped as gnome-getting-started-docs in the core GNOME distribution.
6
7The GNOME Documentation Project (GDP) is responsible for this documentation.
8
9GDP homepage: http://live.gnome.org/DocumentationProject
10GDP mailing list: http://mail.gnome.org/mailman/listinfo/gnome-doc-list
11
12Translators
13-----------
14
15Although this guide includes a number of media files (videos, SVGs),
16translators just need to translate a single POT file for the Getting Started
17guide, which also includes strings extracted from the media files.
18
19Where to get translated videos
20------------------------------
21
22As a temporary workaround for https://bugzilla.gnome.org/show_bug.cgi?id=699998,
23translated videos are not stored in the Git repository anymore, instead, they
24are pulled from an external source at the following URL when releasing a new
25tarball:
26
27http://people.gnome.org/~jimmac/gnome-getting-started-docs/
28
29Rendering video files
30---------------------
31
32Rendering translated videos is not currently supported at build time. If you
33want to have the video files generated for your language, please get in touch
34with gnome-getting-started-docs maintainers. The plan is to have the video
35files generated for all available languages when releasing a new tarball.
36
37See the animation/language-whitelist.txt file in the gnome-getting-started-docs
38repository for a list of languages for which the videos are currently rendered.
39
40Generating SVG files
41--------------------
42
43To generate translated SVGs that are used as still images for some topics in
44the guide, run the following command in the gnome-getting-started-docs root
45directory:
46
47./autogen.sh && make
48
49Then change to the gnome-help/<your_language>/ directory to see your
50translated SVGs.
51
52Note that depending on your distribution, you may need to install some
53additional packages to run the commands.
54
55Please do not commit the generated SVGs, these files will be regenerated for
56all available languages when releasing a new tarball. The .gitignore file is
57properly set to ignore these files.
58
59The gs-browse-web.page file
60---------------------------
61
62The gs-browse-web.page file contains conditionalized information on both the
63upstream default browser Web (Epiphany) and Firefox, which often replaces Web
64as the default browser downstream.
65
66See comments in the gs-browse-web.page file for a hint on how to adjust the
67file so that the appropriate information is displayed for your downstream
68distribution.
69
70Language packs
71--------------
72
73Given the size of the video files, distributors might want to create
74language packs for individual locales, as the overall package size for
75the gnome-getting-started-docs package would be too large otherwise.
76
77Reporting problems
78------------------
79
80If you find problems in the documentation, please report bugs:
81
82https://gitlab.gnome.org/GNOME/gnome-getting-started-docs/issues
83