Skip to content

Latest commit

 

History

History
79 lines (53 loc) · 2.58 KB

README.md

File metadata and controls

79 lines (53 loc) · 2.58 KB
Raw

Orcania

Potluck with different functions for different purposes that can be shared among C programs.

.github/workflows/ccpp.yml

Documentation

Library documentation is available in the online documentation.

Installation

Distribution packages

Packaging status

Orcania is available in multiple distributions as official package. Check out your distribution documentation to install the package automatically.

Pre-compiled packages

You can install Orcania with a pre-compiled package available in the release pages.

Build from source

Download Orcania source code from GitHub:

$ git clone https://github.com/babelouest/orcania.git
$ cd orcania

CMake - Multi architecture

CMake minimum 3.5 is required.

Run the CMake script in a sub-directory, example:

$ git clone https://github.com/babelouest/orcania.git
$ cd orcania/
$ mkdir build
$ cd build
$ cmake ..
$ make && sudo make install

The available options for CMake are:

  • -DBUILD_STATIC=[on|off] (default off): Build the static archive in addition to the shared library
  • -DWITH_STRSTR=[on|off] (default off): Force using inline implementation of strstr
  • -DBUILD_ORCANIA_TESTING=[on|off] (default off): Build unit tests
  • -DINSTALL_HEADER=[on|off] (default on): Install header file orcania.h
  • -DBUILD_RPM=[on|off] (default off): Build RPM package when running make package
  • -DBUILD_ORCANIA_DOCUMENTATION=[on|off] (default off): Build the documentation, doxygen is required
  • -DCMAKE_BUILD_TYPE=[Debug|Release] (default Release): Compile with debugging symbols or not

Good ol' Makefile - Linux only

Go to src/ directory, compile and install:

$ cd src
$ make && sudo make install

This will install Orcania's files under /usr/local/ DESTDIR.

If you want to force using inline implementation of strstr, you can append the build option STRSTRFLAG=1. This is useful if your system doesn't have an implementation of the function strstr but isn't listed as one in Orcania. Like FreeRTOS.

$ cd src
$ make STRSTRFLAG=1

To build and install as a static archive, use the make commands make static*:

$ cd src
$ make static && sudo make static-install # or make DESTDIR=/tmp static-install if you want to install in `/tmp/lib`