diff options
author | Philipp Gesang <phg@phi-gamma.net> | 2018-12-09 21:29:09 +0100 |
---|---|---|
committer | Philipp Gesang <phg@phi-gamma.net> | 2018-12-09 21:29:09 +0100 |
commit | 4a754036826405dd488b0718315b434c9cb726d0 (patch) | |
tree | 339d4f6eda5340fcff5dc141639e6100996bd143 /readme.rst | |
parent | 5835b73456898c7bd48d3ed9ec2539c1b560f9b8 (diff) | |
download | ocaml-sid-4a754036826405dd488b0718315b434c9cb726d0.tar.gz |
doc: outline usage
Diffstat (limited to 'readme.rst')
-rw-r--r-- | readme.rst | 7 |
1 files changed, 7 insertions, 0 deletions
@@ -5,6 +5,13 @@ format. Includes a utility ``sidparse`` for dissecting SIDs on the command line. +entry points +------------ + +Convert to and from the string format using the *to_string* and *of_string* +functions. The binary representations can be encoded and decoded using the +corresponding *to_bytes* and *of_bytes* methods. + building -------- The main build system is Oasis_, but there is a wrapper for OPAM to simplify |