[doc] Moved installation from mercurial forest in appendix. Cleaned installation section but needs improvements.
authorSandrine Ribeau <sandrine.ribeau@logilab.fr>
Wed, 19 Nov 2008 17:35:20 -0800
changeset 105 300166b41ea9
parent 104 8a62d2db3392
child 106 fa179de1a787
[doc] Moved installation from mercurial forest in appendix. Cleaned installation section but needs improvements.
doc/book/en/03-01-installation.en.txt
doc/book/en/21-05-mercurial.en.txt
doc/book/en/21-06-mercurial-forest.en.txt
doc/book/en/21-appendix.en.txt
--- a/doc/book/en/03-01-installation.en.txt	Wed Nov 19 17:05:34 2008 -0800
+++ b/doc/book/en/03-01-installation.en.txt	Wed Nov 19 17:35:20 2008 -0800
@@ -6,48 +6,47 @@
 Installation of `Cubicweb` and its dependancies
 -----------------------------------------------
 
-`CubicWeb` is available as a Mercurial repository using the forest extension.
-First make sure Mercurial is installed and that the forest extension is
-available.
+`CubicWeb` is available as a debian package as well as an archive.
+We will detail here the two easiest way to set-up `CubciWeb` 
+environment.
+
+Debian packages
+```````````````
+You need first to make sure that you added our public repository
+in the list of sources you packages manager will search in.
+
+Depending on the debian distribution you are using here are all the
+available options: ::
+
+  deb http://ftp.logilab.org/dists/ lenny/
+  deb http://ftp.logilab.org/dists/ hardy/
+  deb http://ftp.logilab.org/dists/ sid/
 
-Mercurial installation
-``````````````````````
+As we assume you are installing `CubciWeb` on a debian machine, please
+add the appropriate line from above in ``/etc/apt/sources.list``.
+
+You can now install the required packages with the follwoing command: ::
+
+  apt-get install cubicweb
+
+This is it!
 
-Please refer to the project online documentation Mercurial_.
-.. _Mercurial: http://www.selenic.com/mercurial/wiki/
+``tar.gz`` archive
+``````````````````
 
-We also provide in this book a quick guide on how to use
-Mercurial (:ref:`Mercurial`).
+You can download our sources at: ::
+
+  http://ftp.logilab.org/pub/cubicweb/
+
+Unpack the sources
 
 
-Installation of the forest extension
-````````````````````````````````````
 
-Set up the forest extension by getting a copy of the sources 
-from http://hg.akoha.org/hgforest/ and adding the following 
-lines to your ``~/.hgrc``: ::
-
-   [extensions]
-   hgext.forest=
-   # or, if forest.py is not in the hgext dir:
-   # forest=/path/to/forest.py
 
-Get `CubicWeb` source code
-``````````````````````````
-
-Clone the forest in you working directory.
-
-::
+.. note::
+  `CubicWeb` is also available as a Mercurial repository using the forest
+  extension (see :ref:`MercurialForestInstall` for more details).
 
-  hg fclone http://www.logilab.org/hg/forests/cubicweb
-
-.. note:: 
-  We recommand you to create a symbolic link to the command ``cubicweb-ctl``
-  as you will use it pretty often.
-
-  ::
-    
-    $ ln -s /path/to/forest/cubicweb/bin/cubicweb-ctl ~/bin
 
 Postgres installation
 `````````````````````
--- a/doc/book/en/21-05-mercurial.en.txt	Wed Nov 19 17:05:34 2008 -0800
+++ b/doc/book/en/21-05-mercurial.en.txt	Wed Nov 19 17:35:20 2008 -0800
@@ -1,9 +1,9 @@
 .. -*- coding: utf-8 -*-
 
-.. _Mercurial:
+.. _MercurialPresentation:
 
 Présentation de Mercurial
--------------------------
+=========================
 
 Introduction
 ````````````
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/book/en/21-06-mercurial-forest.en.txt	Wed Nov 19 17:35:20 2008 -0800
@@ -0,0 +1,52 @@
+.. -*- coding: utf-8 -*-
+
+.. _MercurialForestInstall:
+
+Installation of `CubicWeb` with Mercurial
+=========================================
+
+`CubicWeb` is available as a Mercurial repository using the forest extension.
+First make sure Mercurial is installed and that the forest extension is
+available.
+
+Mercurial installation
+``````````````````````
+
+Please refer to the project online documentation Mercurial_.
+
+.. _Mercurial: http://www.selenic.com/mercurial/wiki/
+
+We also provide in this book a quick guide on how to use
+Mercurial (:ref:`MercurialPresentation`).
+
+
+Installation of the forest extension
+````````````````````````````````````
+
+Set up the forest extension by getting a copy of the sources 
+from http://hg.akoha.org/hgforest/ and adding the following 
+lines to your ``~/.hgrc``: ::
+
+   [extensions]
+   hgext.forest=
+   # or, if forest.py is not in the hgext dir:
+   # forest=/path/to/forest.py
+
+Get `CubicWeb` source code
+``````````````````````````
+
+Clone the forest in you working directory.
+
+::
+
+  hg fclone http://www.logilab.org/hg/forests/cubicweb
+
+.. note:: 
+  We recommand you to create a symbolic link to the command ``cubicweb-ctl``
+  as you will use it pretty often.
+
+  ::
+    
+    $ ln -s /path/to/forest/cubicweb/bin/cubicweb-ctl ~/bin
+
+
--- a/doc/book/en/21-appendix.en.txt	Wed Nov 19 17:05:34 2008 -0800
+++ b/doc/book/en/21-appendix.en.txt	Wed Nov 19 17:35:20 2008 -0800
@@ -13,4 +13,5 @@
    21-03-modules-stdlib.en.txt
    21-04-modules-cbw-api.en.txt
    21-05-mercurial.en.txt
+   21-06-mercurial-forest.en.txt