Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 77 lines (54 sloc) 1.766 kB
1a66463 @samoht Update README
samoht authored
1 # OPAM - A package manager for OCaml
3656b4d @OCamlPro-FabriceLeFessant First commit
OCamlPro-FabriceLeFessant 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
544ae0e @samoht Fix README
samoht authored
5 [Mancoosi](http://www.mancoosi.org/) project, which is, 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
2ea165b @samoht Bump version to 0.3.2
samoht authored
10 * ocaml
11 * curl
a7ec30c @tuong At upload time, the archive is sent everytime now.
tuong authored
12
c5b08a5 @samoht Update README.md
samoht authored
13 ### Compiling OPAM
84f4fc3 @samoht Update README.md
samoht authored
14
29a6804 @samoht Add install instructions
samoht authored
15 To compile `opam`, simply run:
f247b50 @samoht Update README
samoht authored
16
7600e90 @samoht Update README
samoht authored
17 ```
18 make
19 ```
3656b4d @OCamlPro-FabriceLeFessant First commit
OCamlPro-FabriceLeFessant authored
20
6bec3e9 @samoht Update master
samoht authored
21 This will fetch the necessary archives if they are not already
22 downloaded and then build OPAM. If you just want to get the
23 necessary dependencies without compiling the project, run
24 `make clone`.
fb6191e @samoht Update README.md
samoht authored
25
29a6804 @samoht Add install instructions
samoht authored
26 ### Installing OPAM
27
28 To install opam in `/usr/local/bin` simply run:
29
30 ```
31 sudo make install
32 ```
33
34 If you want to install OPAM in a different path:
35
36 ```
37 make BIN=$HOME/bin install
38 ```
39
c5b08a5 @samoht Update README.md
samoht authored
40 ### Using opam
7f510c5 @samoht Few makefile tweaks
samoht authored
41
c5b08a5 @samoht Update README.md
samoht authored
42 All of the OPAM state is held in the `~\.opam` directory in your home
43 directory, including compiler installations. You should never need to
44 switch to a root user to install packages. Package listings are
291de24 @samoht Update master
samoht authored
45 obtained through remote sources.
7f510c5 @samoht Few makefile tweaks
samoht authored
46
47 ```
c5b08a5 @samoht Update README.md
samoht authored
48 opam init
49 eval `opam config -env`
7600e90 @samoht Update README
samoht authored
50 ```
51
c5b08a5 @samoht Update README.md
samoht authored
52 The first command creates `~\.opam` and set-up `opam.ocamlpro.com` as
d222c5b @tuong [doc] update README and API
tuong authored
53 default repository. If `OCaml` is not installed, you can add the option
54 `-comp VERSION` (if the remote repository contains the associated
55 `VERSION.comp` description file).
56 The second command updates your local environment
c5b08a5 @samoht Update README.md
samoht authored
57 to use the packages installed by OPAM. For convenience, you can add
58 this line in your `~/.profile`.
7600e90 @samoht Update README
samoht authored
59
60 ```
c5b08a5 @samoht Update README.md
samoht authored
61 opam list
7f510c5 @samoht Few makefile tweaks
samoht authored
62 ```
e04535c @samoht Add API documentation
samoht authored
63
c5b08a5 @samoht Update README.md
samoht authored
64 As expected, this command lists all the available packages. We can now
65 install some packages (for instance `lwt`):
e04535c @samoht Add API documentation
samoht authored
66
c5b08a5 @samoht Update README.md
samoht authored
67 ```
68 opam install lwt
69 ```
7600e90 @samoht Update README
samoht authored
70
71 ## Documentation
e04535c @samoht Add API documentation
samoht authored
72
b5f303d @samoht Update master
samoht authored
73 Some technical documentations are available in `doc`:
c5b08a5 @samoht Update README.md
samoht authored
74
75 * the API is available in `doc/html/`
76 * The design documents are available in `doc/specs/`
Something went wrong with that request. Please try again.