Commit 78083c55 authored by Frederic Peters's avatar Frederic Peters
Browse files

Complete installation & configuration instructions

parent 2f891d60
......@@ -9,7 +9,9 @@ Installation
libgo is made to run from its checkout directory, there is no need for
installation.
configure and make are used to build translations.
configure and make are used to build translations, running ./autogen.sh
&& make will build the necessary bits. Dependencies are gettext,
xsltproc, gnome-doc-utils, and yelp-tools.
Usage
......@@ -47,7 +49,7 @@ Notable configuration variables are:
- ftp_gnome_org_local_copy: path to local copy of ftp.gnome.org, this is
used not to download all the files that are already local.
- download_cache_dir: path to download cache directory (default:
~/.lgo/cache/)
......@@ -55,7 +57,7 @@ Notable configuration variables are:
- version_min, version_max: minimum/maximum GNOME version to have
documentation for (absolute minimum is 2.12.0).
Note about versions:
- libgo will only build the latest version of a serie,
- libgo will only build the latest version of the latest development
......@@ -64,12 +66,38 @@ Notable configuration variables are:
- modules: list of modules to use (default: None, meaning all modules);
this can be used to restrict modules to a specific subset, example:
['eog', 'gedit']
- languages: list of languages to build (default: None, meaning all
languages); this can be used to restrict languages to a specific subset,
example: ['en', 'sv', 'ja', 'es']
Apache Configuration
====================
libgo generates a static website, to be served by Apache using its MultiViews
mode for language negociation, a working virtualhost would be:
<VirtualHost *:80>
ServerName library.gnome.org
DocumentRoot /var/www/library.gnome.org/
<Directory /var/www/library.gnome.org/>
Options All
AllowOverride All
Require all granted
Options +MultiViews
</Directory>
# Make it possible to use a cookie to negociate language
LanguagePriority en
ForceLanguagePriority Prefer Fallback
SetEnvIf Cookie "language=(.+)" prefer-language=$1 Header append
Vary cookie
Header append Vary Cookie
</VirtualHost>
System Requirements
===================
......@@ -79,7 +107,7 @@ To build everything from 2.12 to current 2.19 development version :
- download cache (everything from ftp.gnome.org): 829M
- extracted files: 679M
- web site: 624M
- time:
- building and scanning all documentation: 2h40
- scanning (already built) documentation: 0h20
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment