OASIS

Architecture for building OCaml libraries and applications

Help spread the word

The best way to help the OASIS project is to use it, of course. From the beginning, OASIS has been designed using real-life projects as examples to define features. The first public version was the one matching the most common requirements of the author's projects. It is now time to expand this requirements to your projects as well.

We really appreciate to get your feedback. Use bug reports or feature requests.

Once your project is OASIS enabled, you can advertise for the OASIS project on your project webpages. You can also ask to be added to the list of projects using OASIS.

Get involved into development

The main page for development is the project on forge.ocamlcore.org. You can browse the source code of the project and of its website.

To get a copy of the source tree, you must use git anonymously:

$> git clone git://github.com/ocaml/oasis.git

Once you have the source code, you can pick a bug or a feature request to fix.

You can send back patches using git. Create an account on github, fork the project, push your changes to your github copy and submit a "Pull Request". To push your changes, if your github user is USERNAME, first add a new remote location to your local repository (you have to do that once only):

$> git remote add github git@github.com:USERNAME/oasis.git

and then push your master branch to it:

$> git push github master

Alternatively, you can send your patch to the mailing list:

$> git format-patch -M --to=oasis-devel@lists.forge.ocamlcore.org origin/master

or with a bug report.

To update the source code with the latest available version:

$> git pull

Further documentation about git can be found on git-scm.com. See also Github help.

Translation

OASIS uses ocaml-gettext for internationalization support. If you want to translate it to another languages, just fetch the .pot files and start translating.

Once done, you can submit a bug report or send us an email so that we can include your work into the next version of OASIS.

Write plugins and tools

If your requirements cannot be fulfilled by the actual code, you can extend OASIS features through plugins. For now, plugins development need to be done with the OASIS source tree.

Writing tools is not yet very easy. You need to depend only on the content of src/oasis, which should become a library soon. Theses files contain everything needed to parse and extract information from an _oasis file. You can also subscribe to the oasis-devel mailing list.

Fork me on GitHub