Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 90 lines (58 sloc) 2.903 kB
1a66463 @samoht Update README
samoht authored
1 # OPAM - A package manager for OCaml
3656b4d @OCamlPro-FabriceLeFessant First commit
OCamlPro-FabriceLeFessant authored
2
415544e @samoht Update README.md
samoht authored
3 OPAM is a source-based package manager for OCaml. It supports multiple simultaneous
4 compiler installations, flexible package constraints, and a Git-friendly development
5 workflow.
33d1c10 @samoht Update README.md
samoht authored
6
6cd85ba @samoht More README tweaks
samoht authored
7 OPAM is created and maintained by [Thomas Gazagnaire](https://github.com/samoht) from
8 [OCamlPro](http://www.ocamlpro.com).
f247b50 @samoht Update README
samoht authored
9
6cd85ba @samoht More README tweaks
samoht authored
10 To get started, checkout the [Quick
11 Install](http://opam.ocamlpro.com/doc/Quick_Install.html) guide.
a7ec30c @tuong At upload time, the archive is sent everytime now.
tuong authored
12
6cd85ba @samoht More README tweaks
samoht authored
13 ## Versioning
21ecb3d @samoht Add quick install instruction
samoht authored
14
6cd85ba @samoht More README tweaks
samoht authored
15 For transparency and insight into our release cycle, and for striving
16 to maintain backward compatibility, OPAM will be maintained under
17 the Semantic Versioning guidelines as much as possible.
18
19 Releases will be numbered with the following format:
20
21 ```
22 <major>.<minor>.<patch>
23 ```
24
25 And constructed with the following guidelines:
26
27 * Breaking backward compatibility bumps the major (and resets the minor and patch)
28 * New additions without breaking backward compatibility bumps the minor (and resets the patch)
29 * Bug fixes and misc changes bumps the patch
30
31 For more information on SemVer, please visit http://semver.org/.
32
33 It is expected than upgrade work transparently between minor releases:
34 an OPAM binary with version `x.y.z` should be able to use the OCaml
35 packages and compilers created with OPAM version `x.(y-1).0`
36
37 ## Bug tracker
38
39 Have a bug or a feature request ?
40 [Please open a new issue](https://github.com/OCamlPro/opam/issues).
41 Before opening any issue, please search for existing issues.
42
43 ## Community
44
45 Keep track of development and community news.
46
47 * Have a question that's not a feature request or bug report?
48 [Ask on the mailing list](http://lists.ocaml.org/listinfo/infrastructure).
49
50 * Chat with fellow OPAMers in IRC. On the `irc.freenode.net` server,
51 in the `#ocaml` or the `#opam` channel.
52
53 ## Contributing
54
55 Please submit all pull requests against the `master` branch.
21ecb3d @samoht Add quick install instruction
samoht authored
56
6b6a0bd @samoht Simplify README
samoht authored
57 ## Documentation
171e275 @samoht Update README
samoht authored
58
6cd85ba @samoht More README tweaks
samoht authored
59 #### User Manual
171e275 @samoht Update README
samoht authored
60
6b6a0bd @samoht Simplify README
samoht authored
61 The main documentation entry point to OPAM is the user manual,
62 available using `opam --help`. To get help for a specific command, use
63 `opam <command> --help`.
171e275 @samoht Update README
samoht authored
64
6cd85ba @samoht More README tweaks
samoht authored
65 #### Tutorials
5ca91df @samoht Add auto-completion scripts
samoht authored
66
51b063f @samoht Fix typos in README
samoht authored
67 A collection of tutorials are available online at http://opam.ocamlpro.com.
9178645 @samoht More README tweaks
samoht authored
68 These tutorials are automatically generated from the
69 [wiki](https://github.com/OCamlPro/opam/wiki/_pages) and
51b063f @samoht Fix typos in README
samoht authored
70 are also available in PDF format in the `doc/tutorials` directory.
5ca91df @samoht Add auto-completion scripts
samoht authored
71
6cd85ba @samoht More README tweaks
samoht authored
72 #### API, Code Documentation and Developpper Manual
5ca91df @samoht Add auto-completion scripts
samoht authored
73
9178645 @samoht More README tweaks
samoht authored
74 The API documentation is available under the `doc/html/` directory and
75 the developer manual is in the `doc/dev-manual/` directory.
e04535c @samoht Add API documentation
samoht authored
76
6cd85ba @samoht More README tweaks
samoht authored
77 ## Copyright and license
78
79 Copyright 2012-2013 OCamlPro
80 Copyright 2012 INRIA
81
82 All rights reserved. OPAM is distributed under the terms of
83 the GNU Public License version 3.0.
84
85 OPAM is distributed in the hope that it will be useful,
86 but WITHOUT ANY WARRANTY; without even the implied warranty of
87 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
88 GNU General Public License for more details.
89
Something went wrong with that request. Please try again.