Skip to content
Newer
Older
100644 59 lines (41 sloc) 1.39 KB
1a66463 @samoht Update README
samoht authored
1 # OPAM - A package manager for OCaml
3656b4d @lefessan First commit
lefessan authored
2
c5b08a5 @samoht Update README.md
samoht authored
3 OPAM is a package manager for OCaml, based on the
4 [CUDF](http://mancoosi.org/cudf/) library developped by the
5 [Mancoosi](http://www.mancoosi.org/) project, which are, among other
6bec3e9 @samoht Update master
samoht authored
6 things, used by Debian to manage their packages.
c5b08a5 @samoht Update README.md
samoht authored
7
8 ### Prerequisites:
f247b50 @samoht Update README
samoht authored
9
10 * ocaml
a7ec30c @tuong At upload time, the archive is sent everytime now.
tuong authored
11
c5b08a5 @samoht Update README.md
samoht authored
12 ### Compiling OPAM
84f4fc3 @samoht Update README.md
samoht authored
13
c5b08a5 @samoht Update README.md
samoht authored
14 * To compile `opam`, simply run:
f247b50 @samoht Update README
samoht authored
15
7600e90 @samoht Update README
samoht authored
16 ```
17 make
18 ```
3656b4d @lefessan First commit
lefessan authored
19
6bec3e9 @samoht Update master
samoht authored
20 This will fetch the necessary archives if they are not already
21 downloaded and then build OPAM. If you just want to get the
22 necessary dependencies without compiling the project, run
23 `make clone`.
fb6191e @samoht Update README.md
samoht authored
24
c5b08a5 @samoht Update README.md
samoht authored
25 ### Using opam
7f510c5 @samoht Few makefile tweaks
samoht authored
26
c5b08a5 @samoht Update README.md
samoht authored
27 All of the OPAM state is held in the `~\.opam` directory in your home
28 directory, including compiler installations. You should never need to
29 switch to a root user to install packages. Package listings are
291de24 @samoht Update master
samoht authored
30 obtained through remote sources.
7f510c5 @samoht Few makefile tweaks
samoht authored
31
32 ```
c5b08a5 @samoht Update README.md
samoht authored
33 opam init
34 eval `opam config -env`
7600e90 @samoht Update README
samoht authored
35 ```
36
c5b08a5 @samoht Update README.md
samoht authored
37 The first command creates `~\.opam` and set-up `opam.ocamlpro.com` as
38 default repository. The second command update your local environment
39 to use the packages installed by OPAM. For convenience, you can add
40 this line in your `~/.profile`.
7600e90 @samoht Update README
samoht authored
41
42 ```
c5b08a5 @samoht Update README.md
samoht authored
43 opam list
7f510c5 @samoht Few makefile tweaks
samoht authored
44 ```
e04535c @samoht Add API documentation
samoht authored
45
c5b08a5 @samoht Update README.md
samoht authored
46 As expected, this command lists all the available packages. We can now
47 install some packages (for instance `lwt`):
e04535c @samoht Add API documentation
samoht authored
48
c5b08a5 @samoht Update README.md
samoht authored
49 ```
50 opam install lwt
51 ```
7600e90 @samoht Update README
samoht authored
52
53 ## Documentation
e04535c @samoht Add API documentation
samoht authored
54
c5b08a5 @samoht Update README.md
samoht authored
55 Some technical documentations are availables in `doc`:
56
57 * the API is available in `doc/html/`
58 * The design documents are available in `doc/specs/`
Something went wrong with that request. Please try again.