| master | develop | | ------ | ------- | |||

Documentation

The documentation is available at mahlet-inc.github.io.

Pre-built binaries

There are pre-built binaries of the latest release on the GitHub releases page.

Using Hobbits

Read the user guide in the documentation and/or watch this walkthrough video

Building with Conan, Python 3, and CMake 3.12+

1. Install Conan with pip:

   pip install conan

2. Configure Conan to use a custom remote and keep

   *.pyc

   files:

   conan remote add hobbitsconan https://helloadam.jfrog.io/artifactory/api/conan/conan
   conan config set general.keep_python_files=True
   

3. Use conan to get/build dependencies, then build and package hobbits:

   mkdir build
   cd build
   conan install .. --build=missing
   conan build ..
   conan package ..
   

If you have any issues building, you can check out more detailed steps and environmental setup in the continuous integration files or open an issue.

Plain CMake (no Conan) building also works if you have your dependencies handled. The CentOS 7 GCC 4.8 CI build does this.

Adding plugins

Read the plugin developer guide in the documentation. As of v0.50.0, the plugin interfaces are pretty stable. It is possible, maybe even likely, that plugins built to the current interfaces will be version 1.x.x-compatible.

Get Involved

Join our Discord server, send us an email at [email protected], and tell your colleagues. We'd love contributions and resumes, but we'll settle for bug reports and memes.