summaryrefslogtreecommitdiff
path: root/readme.rst
diff options
context:
space:
mode:
authorPhilipp Gesang <phg@phi-gamma.net>2018-11-06 14:22:42 +0100
committerPhilipp Gesang <phg@phi-gamma.net>2018-11-06 14:22:42 +0100
commit372fc7cd22be767e332a8e22266ea8209bdd5e75 (patch)
treee2331616439b824643a2b0f5cdb46e2f86b35a95 /readme.rst
parentaeb05e247128d00681fcf2b25baa589743e44768 (diff)
downloadocaml-sid-372fc7cd22be767e332a8e22266ea8209bdd5e75.tar.gz
readme: add sections describing build and dev repo
Diffstat (limited to 'readme.rst')
-rw-r--r--readme.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/readme.rst b/readme.rst
index 4a95f48..a51b7e9 100644
--- a/readme.rst
+++ b/readme.rst
@@ -5,6 +5,39 @@ format.
Includes a utility ``sidparse`` for dissecting SIDs on the command line.
+building
+--------
+The main build system is Oasis_, but there is a wrapper for OPAM to simplify
+dependency management.
+
+A manual build involves the following steps: ::
+
+ $ opam install stdint cmdliner ounit
+ $ oasis setup
+ $ make
+
+This will generate the library targets for ``sid.*`` as well as a utility
+``sidparse.native`` that works similarly to ``uuidparse`` for UUIDs, and
+unit test binary ``sid_test.byte``.
+
+To view the HTML documentation, issue ::
+
+ $ make doc
+
+and point your browser at ``./_build/sid_intf.docdir/index.html``.
+
+.. _Oasis: https://github.com/ocaml/oasis
+.. _OPAM: https://opam.ocaml.org/
+
+project
+-------
+The master repo_ is hosted on gitlab.com, please use the issue tracker there or
+email me_ directly. Gitlab is also where releases_ are published.
+
+.. _repo: https://gitlab.com/phgsng/ocaml-sid
+.. _releases: https://gitlab.com/phgsng/ocaml-sid/tags
+.. _me: mailto:phg@phi-gamma.net
+
references
----------
SIDs are specified in MS-DTYP_.