diff options
Diffstat (limited to 'docs/install.rst')
-rw-r--r-- | docs/install.rst | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/install.rst b/docs/install.rst new file mode 100644 index 0000000..914e210 --- /dev/null +++ b/docs/install.rst @@ -0,0 +1,34 @@ +.. _installing: + +Installation guide +================== + +libcasio is either built as a static or shared library, and is made to be +interfaced with C programs. The method of installing or building depends on +the system you're using: pick the one that fits yours! + +POSIX systems (manual build) +---------------------------- + +To configure, use ``./configure <options>``. Options are used as +``--<name>=<value>``. The following are some build options: + +``--target=<target>`` + The target for which to produce the library (by default, native). + +``--static`` + Produce a static library (by default, shared). + +``--windows`` + Use the Windows versions of the final formats (dll instead of elf, + lib instead of coff). + +``--no-log``, ``--loglevel=<level>``: + If we should include debugging content (but keep the interface), and if + yes, what the default library log level. See :ref:`logging` for more + information. + +``--maintainer`` + Alias for ``--loglevel=info``, also introduces more compilation warnings. + +Other options are packaging options (todo: add more info about them here). |