[gnome-getting-started-docs] Add some basic instructions to README



commit 9043572726f224c9e17ba0cf5c9e2853376b3249
Author: Petr Kovar <pkovar redhat com>
Date:   Thu May 2 19:28:23 2013 +0200

    Add some basic instructions to README
    
    For translators & distributors.

 README |   75 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 75 insertions(+), 0 deletions(-)
---
diff --git a/README b/README
index e69de29..3bca3e6 100644
--- a/README
+++ b/README
@@ -0,0 +1,75 @@
+gnome-getting-started-docs
+==========================
+
+This package contains the Getting Started guide which is packaged and
+shipped as gnome-getting-started-docs in the core GNOME distribution.
+
+The GNOME Documentation Project (GDP) is responsible for this documentation.
+
+GDP homepage: http://live.gnome.org/DocumentationProject
+GDP mailing list: http://mail.gnome.org/mailman/listinfo/gnome-doc-list
+
+Translators
+-----------
+
+Although this guide contains a number of media files (videos, SVGs),
+translators just need to follow the usual workflow to translate the guide,
+that is to translate the POT file for the Getting Started guide, which also
+includes the strings extracted from the media files.
+
+Generating SVG files
+--------------------
+
+To generate translated SVGs that are used as still images for some topics in
+the guide, run the following command in the gnome-getting-started-docs root
+directory:
+
+./autogen.sh && make
+
+Then change to the getting-started/<your_language>/ directory to see your
+translated SVGs.
+
+Note that depending on your distribution, you may need to install some
+additional packages to run the commands.
+
+Please do not commit the generated SVGs, these files will be regenerated for
+all available languages when releasing a new tarball. The .gitignore file is
+properly set to ignore these files.
+
+Rendering video files
+---------------------
+
+Rendering translated videos is not currently supported at build time. If you
+want to have the video files generated for your language, please get in touch
+with gnome-getting-started-docs maintainers. The plan is to have the video
+files generated for all available languages when releasing a new tarball.
+
+See the animation/language-whitelist.txt file in the gnome-getting-started-docs
+repository for a list of languages for which the videos are currently rendered.
+
+Language packs
+--------------
+
+Given the size of the video files, distributors might want to create
+language packs for individual locales, as the overall package size for
+the gnome-getting-started-docs package would be too large otherwise.
+
+The gs-browse-web.page & gs-browse-web-firefox.page files
+---------------------------------------------------------
+
+By default, the gnome-getting-started-docs package ships both the
+gs-browse-web.page and gs-browse-web-firefox.page files, but only
+the gs-browse-web.page file is actually linked from the Getting Started
+landing page. This is to accommodate the fact that GNOME is shipped with
+Web, which is often replaced with Firefox (or other browser) downstream.
+
+See the gs-browse-web.page and gs-browse-web-firefox.page files for a hint
+on how to adjust the two files so that the appropriate one is linked from
+the landing page.
+
+Reporting Problems
+------------------
+
+If you find problems in the documentation, please report bugs in GNOME Bugzilla:
+
+https://bugzilla.gnome.org/enter_bug.cgi?product=gnome-user-docs&component=getting-started


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]