Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
O
Olm
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Nheko Reborn
Olm
Commits
b79590e4
Commit
b79590e4
authored
6 years ago
by
Hubert Chathi
Browse files
Options
Downloads
Patches
Plain Diff
document how to build with cmake, and how to build the Python bindings
parent
3ebb3b69
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.rst
+47
-3
47 additions, 3 deletions
README.rst
with
47 additions
and
3 deletions
README.rst
+
47
−
3
View file @
b79590e4
...
...
@@ -13,13 +13,30 @@ ratchet, as specified in `<docs/megolm.rst>`_.
Building
--------
To build olm as a shared library run:
To build olm as a shared library run either:
.. code:: bash
cmake . -Bbuild
cmake --build build
or:
.. code:: bash
make
To run the tests run:
Using cmake is the preferred method for building the shared library; the
Makefile may be removed in the future.
To run the tests when using cmake, run:
.. code:: bash
cd build/tests
ctest .
To run the tests when using make, run:
.. code:: bash
...
...
@@ -49,12 +66,39 @@ To build the Xcode workspace for Objective-C bindings, run:
pod install
open OLMKit.xcworkspace
To build olm as a static library (which still needs libstdc++ dynamically) run:
To build the Python bindings, first build olm as a shared library as above, and
then run:
.. code:: bash
cd python
make
to make both the Python 2 and Python 3 bindings. To make only one version, use
``make olm-python2`` or ``make olm-python3`` instead of just ``make``.
To build olm as a static library (which still needs libstdc++ dynamically) run
either:
.. code:: bash
cmake . -Bbuild -DBUILD_SHARED_LIBS=NO
cmake --build build
or
.. code:: bash
make static
The library can also be used as a dependency with CMake using:
.. code:: cmake
find_package(Olm::Olm REQUIRED)
target_link_libraries(my_exe Olm::Olm)
Release process
---------------
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment