Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

More README tweaks

(shameless inspiration from the very good https://github.com/twitter/bootstrap/blob/master/README.md)
  • Loading branch information...
commit 6cd85ba0b32379605df0dd362f71800eb7312800 1 parent 9178645
@samoht samoht authored
Showing with 62 additions and 11 deletions.
  1. +62 −11 README.md
View
73 README.md
@@ -4,35 +4,86 @@ OPAM is a source-based package manager for OCaml. It supports multiple simultane
compiler installations, flexible package constraints, and a Git-friendly development
workflow.
-## Installation
+OPAM is created and maintained by [Thomas Gazagnaire](https://github.com/samoht) from
+[OCamlPro](http://www.ocamlpro.com).
-The recommanded way of installing OPAM is via your OS package manager.
-See the [Quick Install](http://opam.ocamlpro.com/doc/Quick_Install.html) webpage.
+To get started, checkout the [Quick
+Install](http://opam.ocamlpro.com/doc/Quick_Install.html) guide.
-## Upgrade
+## Versioning
-OPAM stores its state under `~/.opam` whose format is (relatively)
-stable between OPAM version. If upgrade the version of OPAM your are
-using, you only need to upgrade the OPAM binary and it will be able to
-pick-up any pre-existing package and compiler installation.
+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`
+
+## Bug tracker
+
+Have a bug or a feature request ?
+[Please open a new issue](https://github.com/OCamlPro/opam/issues).
+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](http://lists.ocaml.org/listinfo/infrastructure).
+
+* 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
+#### 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
+#### Tutorials
A collection of tutorials are available online at http://opam.ocamlpro.com.
These tutorials are automatically generated from the
[wiki](https://github.com/OCamlPro/opam/wiki/_pages) and
are also available in PDF format in the `doc/tutorials` directory.
-### API, Code Documentation and Developpper Manual
+#### API, Code Documentation and Developpper Manual
The API documentation is available under the `doc/html/` directory and
the developer manual is in the `doc/dev-manual/` directory.
+## Copyright and license
+
+Copyright 2012-2013 OCamlPro
+Copyright 2012 INRIA
+
+All rights reserved. OPAM is distributed under the terms of
+the GNU 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.
+
Please sign in to comment.
Something went wrong with that request. Please try again.