Skip to content
Snippets Groups Projects
Normal view Permalink
README.md 1.76 KiB
Newer Older
  • Learn to ignore specific revisions
    • Konstantinos Sideris's avatar
    Initial commit
    Konstantinos Sideris committed
    1 2 
    mtxclient
---
    Joe Donofry's avatar
    Update README and Dockerfile to point to new repo  
    Joe Donofry committed
    3 4 
    [![Build Status](https://travis-ci.org/Nheko-Reborn/mtxclient.svg?branch=master)](https://travis-ci.org/Nheko-Reborn/mtxclient)
[![Build status](https://ci.appveyor.com/api/projects/status/hyp1n9pq3wtv8dqu/branch/master?svg=true)](https://ci.appveyor.com/project/redsky17/mtxclient/branch/master)
    Joe Donofry's avatar
    Update codecov.io link  
    Joe Donofry committed
    5 
    [![codecov](https://codecov.io/gh/Nheko-Reborn/mtxclient/branch/master/graph/badge.svg)](https://codecov.io/gh/Nheko-Reborn/mtxclient)
    Konstantinos Sideris's avatar
    Fix CI errors  
    Konstantinos Sideris committed
    6 
    [![experimental](https://img.shields.io/badge/stability-experimental-orange.svg)](http://github.com/badges/stability-badges)
    Konstantinos Sideris's avatar
    Initial commit
    Konstantinos Sideris committed
    7 8 9 10 11 12 13 
    
Client API library for the Matrix protocol, built on top of Boost.Asio.

## Build instructions

### Dependencies
    Nicolas Werner's avatar
    Require boost 1.70  
    Nicolas Werner committed
    14 
    - Boost 1.70 (includes Boost.Beast and makes the strand interface usable)
    Konstantinos Sideris's avatar
    Initial commit
    Konstantinos Sideris committed
    15 
    - OpenSSL
    Nicolas Werner's avatar
    Bump required c++ version to C++17  
    Nicolas Werner committed
    16 
    - C++ 17 compiler
    Nicolas Werner's avatar
    Update README with required cmake version  
    Nicolas Werner committed
    17 
    - CMake 3.15 or greater (lower versions can work, but they tend to mess up linking the right boost libraries)
    Konstantinos Sideris's avatar
    Initial commit
    Konstantinos Sideris committed
    18 
    - Google Test (for testing)
    Joe Donofry's avatar
    Update README and Dockerfile to point to new repo  
    Joe Donofry committed
    19 
    - libsodium 1.0.14 or greater
    Konstantinos Sideris's avatar
    Initial commit
    Konstantinos Sideris committed
    20
    Konstantinos Sideris's avatar
    Add note on readme about the dependencies  
    Konstantinos Sideris committed
    21 22 
    Boost and GTest will be built automatically by CMake if they're not found on  your system.
    Konstantinos Sideris's avatar
    Initial commit
    Konstantinos Sideris committed
    23 24 
    Below is an example which will build the library along with the tests & examples.
    Konstantinos Sideris's avatar
    Update readme  
    Konstantinos Sideris committed
    25 26 27 28 29 30 31 32 33 34 35 
    #### Linux 

```bash
cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Debug
cmake --build build
```

#### macOS

You will need to pass as argument (`-DOPENSSL_ROOT_DIR`) the installation root of openssl.
    Konstantinos Sideris's avatar
    Initial commit
    Konstantinos Sideris committed
    36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 
    ```bash
cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Debug -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl
cmake --build build
```

You can toggle off the tests & examples by passing `-DBUILD_LIB_TESTS=OFF` &
`-DBUILD_LIB_EXAMPLES=OFF` respectively.

## Running the tests

In order to run the integration tests you'll need a local synapse instance. You
can start an instance with docker by running the following

```bash
make synapse
```
then run the test suite

```bash
make test 
```