Skip to content
Snippets Groups Projects
Normal view Permalink
README.md 1.08 KiB
Newer Older
  • Learn to ignore specific revisions
    • Konstantinos Sideris's avatar
    Initial commit
    Konstantinos Sideris committed
    1 2 
    mtxclient
---
    Konstantinos Sideris's avatar
    Update readme  
    Konstantinos Sideris committed
    3 
    [![Build Status](https://travis-ci.org/mujx/mtxclient.svg?branch=master)](https://travis-ci.org/mujx/mtxclient)
    Konstantinos Sideris's avatar
    Initial commit
    Konstantinos Sideris committed
    4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 
    
Client API library for the Matrix protocol, built on top of Boost.Asio.

## Build instructions

### Dependencies

- Boost 1.66 (includes Boost.Beast)
- OpenSSL
- C++ 11 compiler
- CMake 3.1 or greater
- Google Test (for testing)

Below is an example which will build the library along with the tests & examples.
    Konstantinos Sideris's avatar
    Update readme  
    Konstantinos Sideris committed
    19 20 21 22 23 24 25 26 27 28 29 
    #### 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
    30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 
    ```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 
```