started the README.rst

1 files changed, 95 insertions, 0 deletions

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..5337cfa
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,95 @@
+g-octave
+========
+
+Introduction
+------------
+
+
+What is GNU Octave?
+~~~~~~~~~~~~~~~~~~~
+
+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.
+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.
+
+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. 
+
+
+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 generate ebuilds and Manifest files for the packages, and
+to install 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.
+
+
+Features
+--------
+
+Below is a list of features implemented and planned to the next releases.
+
+* Selection of the packages by name-version **(done)**
+* Selection of the packages by name (using the latest version available)
+  **(done)**
+* Creation of the ebuilds **(done)**
+* Creation of the Manifest files **(done)**
+* Creation of the overlay automatically **(done)**
+* Installation of the packages automatically **(done)**
+* Update the packages already installed
+* Remotion of the installed packages **(done)**
+* Installation of the packages with patches automatically **(done)**
+* List the packages available to install **(done)**
+* Shows detailed info about a package **(done)**
+* Supports multiple versions of the same package **(done)**
+* Forces the recreation of an ebuild **(done)**
+* Forces the recreation of the overlay **(done)**
+* Download auxiliary files (patches, blacklist, dependency list, package
+  database and the eclass) from a mirror using wget **(done)**
+* The user can choose with which download manager will fetch these files
+* Blocks a package to be installed, based on the blacklist, provided by
+  the maintainer of g-octave **(done)**
+* Resolution of the dependencies of packages from the Portage tree, based on the
+  dependency list, provided by the maintainer of g-octave **(done)**
+* 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 **(done)**
+
+
+To-Do
+-----
+
+We have other goals besides implementing the remaining features:
+
+* 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"
+* Improve the script to generate the package database
+* more...
+