Permalink
Browse files

Update README

  • Loading branch information...
1 parent 60846bc commit 7600e9070c091a317e0f16804429d4f20988fe45 @samoht samoht committed May 30, 2012
Showing with 22 additions and 5 deletions.
  1. +22 −5 README.md
View
@@ -23,20 +23,37 @@ This command will download and extract the following archives:
To compile `opam`, simply run:
- make
+```
+make
+```
-This will download the necessary archives if they are not already downloaded and then build OPAM.
+This will download the necessary archives if they are not already
+downloaded and then build OPAM.
## Tests
In order to run the test you should run:
+```
+make tests-rsync
+make tests-git
+make tests-server
+```
+
+Or alternatively:
+
```
make tests
```
+## Scripts
-## Documentation
+Some helper scripts are located in `src/scrips`:
-* the API is available in html/
+* `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
+
+## Documentation
-* The design documents are available in specs/
+* the API is available in `html/`
+* The design documents are available in `specs/`

0 comments on commit 7600e90

Please sign in to comment.