Update README.md

This commit is contained in:
CJ Cobb
2021-06-23 11:12:20 -04:00
committed by GitHub
parent 056e170a56
commit f73d6a8153

View File

@@ -20,6 +20,21 @@ The different clio servers that are using the same dataset do not know about eac
At any given time, there is only one writer, and any synchronization happens via the data model at the database level.
If the writer for a given dataset fails for any reason, one of the other clio nodes will automatically become the writer.
## Requirements
1. Access to a Postgres server or Cassandra cluster. Can be local or remote.
2. Access to one or more rippled nodes. Can be local or remote.
## Building
clio is built with cmake. clio requires c++20, and boost 1.75.0 (for boost json). clio includes rippled as a submodule.
Before building, run `git submodule update --init --recursive`
clio is built with cmake. clio requires c++20, and boost 1.75.0 or later. clio includes rippled as a submodule.
```
git submodule update --init --recursive
mdkir build
cd build
cmake -DCMAKE_C_COMPILER=<your c compiler> -DCMAKE_CXX_COMPILER=<your c++ compiler that supports c++20> -DBOOST_ROOT=<location of boost> ..
cmake --build . -- -j 8
```
## Running
` ./clio_server config.json`