Skip to content

Latest commit

 

History

History
111 lines (76 loc) · 4.09 KB

README.md

File metadata and controls

111 lines (76 loc) · 4.09 KB
Raw

OPAM - A package manager for OCaml

OPAM is a source-based package manager for OCaml. It supports multiple simultaneous compiler installations, flexible package constraints, and a Git-friendly development workflow.

OPAM is created and maintained by OCamlPro.

To get started, checkout the Quick Install guide.

Versioning

For transparency and insight into our release cycle, and for striving to maintain backward compatibility, OPAM will be maintained under the Semantic Versioning guidelines as much as possible.

Releases will be numbered with the following format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

  • Breaking backward compatibility bumps the major (and resets the minor and patch)
  • New additions without breaking backward compatibility bumps the minor (and resets the patch)
  • Bug fixes and misc changes bumps the patch

For more information on SemVer, please visit http://semver.org/.

It is expected than upgrade work transparently between minor releases: an OPAM binary with version x.y.z should be able to use the OCaml packages and compilers created with OPAM version x.(y-1).0

Compiling this repo

  • Make sure you have OCaml and GNU make installed.
  • Run ./configure
  • Run make lib-ext if you don't have the dependencies installed and only need the opam binary (not the libs). This will locally take care of all dependencies for you.
  • Otherwise, make sure to have ocamlfind, ocamlgraph, cmdliner, cudf, dose 3.1.2 and re >= 1.2.0 installed. Or run opam install opam-lib --deps-only if you already have a working instance.
  • Run make
  • Run make install
  • Run make libinstall if needed (this is incompatible with make lib-ext)

Bug tracker

Have a bug or a feature request ? Please open a new issue. Before opening any issue, please search for existing issues.

Community

Keep track of development and community news.

  • Have a question that's not a feature request or bug report? Ask on the mailing list.

  • Chat with fellow OPAMers in IRC. On the irc.freenode.net server, in the #ocaml or the #opam channel.

Contributing

Please submit all pull requests against the master branch.

Documentation

User Manual

The main documentation entry point to OPAM is the user manual, available using opam --help. To get help for a specific command, use opam <command> --help.

Tutorials

A collection of tutorials are available online at http://opam.ocaml.org. These tutorials are automatically generated from the wiki and are also available in PDF format in the doc/tutorials directory.

API, Code Documentation and Developer Manual

The API documentation is available online and under the doc/html/ directory; the developer manual is in the doc/dev-manual/ directory.

Related repositories

  • ocaml/opam-repository is the official repository for OPAM packages and compilers. A number of non-official repositories are also available on the interwebs, for instance on Github.
  • opam2web generates a collection of browsable HTML files for a given repository. It is used to generate http://opam.ocaml.org.
  • opam-rt is the regression framework for OPAM.
  • opamlot is the automated QA environment for OPAM.

Copyright and license

Copyright 2012-2014 OCamlPro
Copyright 2012 INRIA

All rights reserved. OPAM is distributed under the terms of the GNU Lesser General Public License version 3.0.

OPAM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.