From c5b08a55f820185311ca323f8647cea2c2eec17c Mon Sep 17 00:00:00 2001
From: Thomas Gazagnaire <thomas@gazagnaire.org>
Date: Thu, 5 Jul 2012 21:31:43 +0200
Subject: [PATCH] Update README.md

---
 README.md | 66 +++++++++++++++++++++++++++----------------------------
 1 file changed, 33 insertions(+), 33 deletions(-)

diff --git a/README.md b/README.md
index 0be27e342b0..2e2ff407958 100644
--- a/README.md
+++ b/README.md
@@ -1,59 +1,59 @@
 # OPAM - A package manager for OCaml
 
-*Warning* do not use this software in production, it is not yet stable
-
-## Prerequisites:
+OPAM is a package manager for OCaml, based on the
+[CUDF](http://mancoosi.org/cudf/) library developped by the
+[Mancoosi](http://www.mancoosi.org/) project, which are, among other
+things, used by the Debian to manage their packages.
+ 
+### Prerequisites:
 
 * ocaml
 
-## (optional) Preparing the build
-
-    make clone
-
-This command will download and extract the following archives:
-
-* http://www.ocamlpro.com/pub/cudf.tar.gz
-* http://www.ocamlpro.com/pub/dose.tar.gz
-* http://ocaml-extlib.googlecode.com/files/extlib-1.5.2.tar.gz
-* http://www.ocamlpro.com/pub/ocaml-arg.tar.bz2
-* http://ocamlgraph.lri.fr/download/ocamlgraph-1.8.1.tar.gz
-* http://www.ocamlpro.com/pub/ocaml-re.tar.bz2
+### Compiling OPAM
 
-## Building OPAM
-
-To compile `opam`, simply run:
+* To compile `opam`, simply run:
 
 ```
 make
 ```
 
 This will download the necessary archives if they are not already
-downloaded and then build OPAM.
+downloaded and then build OPAM. If you just want to download the
+necessary dependencies without compiling the project, run `make
+clone`.
 
-## Tests
+### Using opam
 
-In order to run the test you should run:
+All of the OPAM state is held in the `~\.opam` directory in your home
+directory, including compiler installations. You should never need to
+switch to a root user to install packages. Package listings are
+obtained through remote sources, the default one being
+`opam.ocamlpro.com`:
 
 ```
-make tests-rsync
-make tests-git
-make tests-server
+opam init
+eval `opam config -env`
 ```
 
-Or alternatively:
+The first command creates `~\.opam` and set-up `opam.ocamlpro.com` as
+default repository. The second command update your local environment
+to use the packages installed by OPAM. For convenience, you can add
+this line in your `~/.profile`.
 
 ```
-make tests
+opam list
 ```
-## Scripts
 
-Some helper scripts are located in `src/scrips`:
+As expected, this command lists all the available packages. We can now
+install some packages (for instance `lwt`):
 
-* `opam-mk-install` helps to create `.install` files
-* `opam-mk-config` helps to create `.config.in` files
-* `opam-mk-repo` helps to create OPAM repositories
+```
+opam install lwt
+```
 
 ## Documentation
 
-* the API is available in `html/`
-* The design documents are available in `specs/`
\ No newline at end of file
+Some technical documentations are availables in `doc`:
+
+* the API is available in `doc/html/`
+* The design documents are available in `doc/specs/`