ARCHIVE/clio
1
0
Fork 0
mirror of https://github.com/XRPLF/clio.git synced 2025-11-05 04:15:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add status to readme (#1035)

Browse Source 
For #844
This commit is contained in:
Sergey Kuznetsov
2023-12-12 17:07:51 +00:00
committed by GitHub
parent d933ce2a29
commit f62e36dc94
3 changed files with 18 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/build.yml vendored
View File

@@ -1,4 +1,4 @@
name: Build Clio name: Build
on: on:
push: push:
branches: [master, release/*, develop] branches: [master, release/*, develop]

2
.github/workflows/nightly.yml vendored
View File

@@ -1,4 +1,4 @@
name: Nightly Clio build and testing name: Nightly release
on: on:
schedule: schedule:
- cron: '0 5 * * 1-5' - cron: '0 5 * * 1-5'

17
README.md
View File

@@ -1,4 +1,7 @@
# Clio # Clio
![Build status](https://github.com/XRPLF/clio/actions/workflows/build.yml/badge.svg?branch=develop)
![Nightly release status](https://github.com/XRPLF/clio/actions/workflows/nightly.yml/badge.svg?branch=develop)
![Clang-tidy checks status](https://github.com/XRPLF/clio/actions/workflows/clang-tidy.yml/badge.svg?branch=develop)
Clio is an XRP Ledger API server. Clio is optimized for RPC calls, over WebSocket or JSON-RPC. Clio is an XRP Ledger API server. Clio is optimized for RPC calls, over WebSocket or JSON-RPC.
Validated historical ledger and transaction data are stored in a more space-efficient format, Validated historical ledger and transaction data are stored in a more space-efficient format,
@@ -91,7 +94,7 @@ conan remove -f xrpl
Navigate to Clio's root directory and perform Navigate to Clio's root directory and perform
```sh ```sh
mkdir build && cd build mkdir build && cd build
conan install .. --output-folder . --build missing --settings build_type=Release -o tests=True conan install .. --output-folder . --build missing --settings build_type=Release -o tests=True -o lint=False
cmake -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release .. cmake -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build . --parallel 8 # or without the number if you feel extra adventurous cmake --build . --parallel 8 # or without the number if you feel extra adventurous
``` ```
@@ -101,6 +104,18 @@ If all goes well, `conan install` will find required packages and `cmake` will d
> **Tip:** To generate a Code Coverage report, include `-o coverage=True` in the `conan install` command above, along with `-o tests=True` to enable tests. After running the `cmake` commands, execute `make clio_tests-ccov`. The coverage report will be found at `clio_tests-llvm-cov/index.html`. > **Tip:** To generate a Code Coverage report, include `-o coverage=True` in the `conan install` command above, along with `-o tests=True` to enable tests. After running the `cmake` commands, execute `make clio_tests-ccov`. The coverage report will be found at `clio_tests-llvm-cov/index.html`.
## Building Clio with Docker
It is possible to build Clio using docker if you don't want to install all the dependencies on your machine.
```sh
docker run -it rippleci/clio_ci:latest
git clone https://github.com/XRPLF/clio
mkdir build && cd build
conan install .. --output-folder . --build missing --settings build_type=Release -o tests=True -o lint=False
cmake -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build . --parallel 8 # or without the number if you feel extra adventurous
```
## Running ## Running
```sh ```sh
./clio_server config.json ./clio_server config.json