changes on README.rst

1 files changed, 46 insertions, 22 deletions

diff --git a/README.rst b/README.rst
index 8f51cc8..a17eb4b 100644
--- a/README.rst
+++ b/README.rst
@@ -1,3 +1,14 @@
+.. _`GNU Octave`: http://octave.org/
+.. _`Octave-Forge`: http://octave.sf.net/
+.. _`g-octave`: http://bitbucket.org/rafaelmartins/g-octave/
+.. _Python: http://python.org/
+.. _simplejson: http://pypi.python.org/pypi/simplejson/
+.. _pycolors: http://pypi.python.org/pypi/pycolors/
+.. _Portage: http://www.gentoo.org/proj/en/portage/ 
+.. _Paludis: http://paludis.pioto.org/
+.. _pkgcore: http://www.pkgcore.org/
+.. _`Gentoo Linux`: http://www.gentoo.org/
+
 g-octave
 ========
 
@@ -7,7 +18,7 @@ Introduction
 What is GNU Octave?
 ~~~~~~~~~~~~~~~~~~~
 
-GNU Octave is a high-level language, primarily intended for numerical
+`GNU Octave`_ is a high-level language, primarily intended for numerical
 computations. It provides a convenient command line interface for solving
 linear and nonlinear problems numerically, and for performing other numerical
 experiments using a language that is mostly compatible with Matlab.
@@ -17,27 +28,25 @@ It may also be used as a batch-oriented language.
 What is Octave Forge?
 ~~~~~~~~~~~~~~~~~~~~~
 
-Octave-Forge is a central location for the collaborative development of
-packages for GNU Octave.
+`Octave-Forge`_ is a central location for the collaborative development of
+packages for `GNU Octave`_.
 
-The Octave-forge packages contains the source for all the functions and
-are designed to work with the Octave package system. In general the packages
-are designed to work with the latest development version of Octave, but
-it should be possible to use most packages with earlier versions. 
+The `Octave-Forge`_ packages contains the source for all the functions and
+are designed to work with the `GNU Octave`_ package system. 
 
 
 What is g-octave
 ~~~~~~~~~~~~~~~~
 
-g-octave is a tool that generates and installs ebuilds for Octave-Forge
-packages "on-the-fly" to Gentoo Linux, using Portage. It's capable to
+`g-octave`_ is a tool that generates and installs ebuilds for `Octave-Forge`_
+packages "on-the-fly" to `Gentoo Linux`_, using Portage_. It's capable to
 generate ebuilds and Manifest files for the packages, and to install
-them using an autogenerated overlay (named g-octave). g-octave can also
+them using an autogenerated overlay (named g-octave). `g-octave`_ can also
 handle patches to the packages automatically. The command line interface
 tries to be very similar to the interface of the **emerge** tool.
 
-At this moment g-octave depends on the Portage package manager to works,
-but the support to Paludis and pkgcore is planned.
+At this moment `g-octave`_ depends on the Portage_ package manager to works,
+but the support to Paludis_ and pkgcore_ is planned.
 
 
 Features
@@ -64,16 +73,19 @@ Below is a list of features implemented and planned to the next releases.
 * The user can force the recreation of an ebuild **(done)**
 * The user can force the recreation of the overlay **(done)**
 * Mask a package to be installed, based on the blacklist, provided by the
-  maintainer of g-octave **(done)**
-* Show the masked packages on the list of packages, with some alert
+  maintainer of `g-octave`_ **(done)**
+* Show the masked packages on the list of packages, with an alert
 * Resolution of the dependencies of packages from the Portage tree, based
-  on the dependency list, provided by the maintainer of g-octave **(done)**
+  on the dependency list, provided by the maintainer of `g-octave`_ **(done)**
 * Supports the installation of multiple packages (not only the dependencies)
-* Handle updates of the eclass and auxiliary files automatically **(done)**
-* Support to Portage **(done)**
-* Support to Paludis
-* Support to pkgcore
-* Configuration file to the main settings (/etc/g-octave.cfg) **(done)**
+* Handle updates of the eclass and the auxiliary files automatically **(done)**
+* Support to Portage_ **(done)**
+* Support to Paludis_
+* Support to pkgcore_
+* Configuration file to the main settings */etc/g-octave.cfg* **(done)**
+* Use colors on the CLI **(done)**
+* The user can disable the use of colors on the CLI **(done)**
+* Logging `g-octave`_ actions
 
 
 To-Do
@@ -81,12 +93,13 @@ To-Do
 
 We have other goals besides implementing the remaining features:
 
+* Port to Python_ >= 3.0
 * Improve the code comments
 * Improve the error handling
 * Improve the overlay management
 * Write a man page
-* Convince upstream to distribute a package database
-* Improve the use as a normal user, using "--pretend"
+* Convince upstream to distribute the package database
+* Improve the use of `g-octave`_ as a normal user, with "--pretend"
 * Improve the script to generate the package database
 * Improve the details available on the packages list
 * more...
@@ -127,3 +140,14 @@ CLI options
 
 *--no-colors*
     don't use colors on the CLI
+
+
+Dependencies
+------------
+
+`g-octave`_ have some basic dependencies:
+
+* Python_ 2
+* Portage_
+* simplejson_
+* pycolors_ (to use colors on the CLI, it's an optional dependency)