started updating the documentation

3 files changed, 74 insertions, 14 deletions

diff --git a/docs/index.rst b/docs/index.rst
index 2906376..dcfbee7 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -31,7 +31,8 @@ Contents
 
 .. toctree::
    :maxdepth: 2
-
+    
+   quickstart
    userguide
    development
    tinderbox
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
new file mode 100644
index 0000000..1ed5c45
--- /dev/null
+++ b/docs/quickstart.rst
@@ -0,0 +1,41 @@
+Quick Start
+===========
+
+This is a svery small set of instructions for the users that just want
+to install a package, and don't care about things like which package manager
+g-octave will use or where g-octave will store your files.
+
+
+Installing g-Octave
+-------------------
+
+With layman installed, install the science overlay::
+    
+    # layman -a science
+
+Install g-octave::
+
+    # emerge -av g-octave
+
+Install g-octave's package database::
+
+    # emerge --config g-octave
+
+
+Installing the package
+----------------------
+
+If you don't care about configurations, the default values are good enough
+for you, then just type::
+    
+    # g-octave -av packagename
+
+
+Just a line!
+------------
+
+If you're really lazy, you can just type::
+
+    # layman -a science && emerge g-octave && emerge --config g-octave && g-octave packagename
+
+If all is ok, your package should be installed now!
diff --git a/docs/userguide.rst b/docs/userguide.rst
index da81089..da747f9 100644
--- a/docs/userguide.rst
+++ b/docs/userguide.rst
@@ -35,33 +35,45 @@ release will need to unmask the ebuild too, adding this to
 
     app-portage/g-octave ~x86
 
-The source code of g-Octave can be found in this Mercurial repository:
+The source code of g-Octave can be found in this Git repository:
 
-http://g-octave.rafaelmartins.eng.br/hg/
+http://git.overlays.gentoo.org/gitweb/?p=proj/g-octave.git;a=summary
 
-You can clone the mercurial repository using this command (with Mercurial
+You can clone the Git repository using this command (with Git
 installed, of course)::
     
-    $ hg clone http://g-octave.rafaelmartins.eng.br/hg/ g-octave
+    $ git clone git://git.overlays.gentoo.org/proj/g-octave.git
 
 The release tarballs can be found here:
 
-http://g-octave.rafaelmartins.eng.br/distfiles/releases/
+http://soc.dev.gentoo.org/~rafaelmartins/g-octave/releases/
 
 
 Configuring g-Octave
 --------------------
 
+Using the file ``/etc/g-octave.cfg``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 If you installed g-Octave correctly, you should find a configuration file
 at ``/etc/g-octave.cfg``.
 
-The main options are ``db`` and ``overlay``, that defines the directory paths
+The main options are ``package_manager``, ``db`` and ``overlay``, that
+defines the package manager used by g-octave and the directory paths
 for the package database and the generated overlay, respectively.
 
 Other options are available. Please read the comments in the configuration
 file.
 
 
+Using environment variables
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+
+
+
+
 Syncronizing the package database
 ---------------------------------
 
@@ -75,14 +87,20 @@ in the first time that you run g-Octave: ::
 Configuring your package manager
 --------------------------------
 
-Portage needs to be able to find the ebuilds generated by g-Octave, then
-you'll need to add the directory path of the overlay (configured in the
-previous step) to the variable ``PORTDIR_OVERLAY``, in the file
-``/etc/make.conf``.
+g-octave can use all the 3 package managers available to Gentoo Linux:
+Portage, Paludis and Pkgcore.
 
-You can use something like this command: ::
-    
-    # echo 'PORTDIR_OVERLAY="/path/to/your/overlay ${PORTDIR_OVERLAY}"' >> /etc/make.conf
+You just need to setup the option ``package_manager`` in the config file
+with the lowercase name of the package manager: portage, paludis, pkgcore.
+
+If you're using Paludis or Pkgcore, you'll need to configure the overlay
+in your package manager configuration files. Please check the documentation
+of your package manager:
+
+- Paludis: http;//paludis.pioto.org/
+- Pkgcore: http://www.pkgcore.org/
+
+Portage will works out of the box.
 
 
 Installing packages