Documenatation update

README.md

@@ -1,32 +1,35 @@
-# attn-server
+# Witness Server for XRPL Sidechains
 
-[![Build Status](https://travis-ci.org/ripple/attn-server.svg?branch=master)](https://travis-ci.org/ripple/attn-server)
-[![Build status](https://ci.appveyor.com/api/projects/status/dd42bs8pfao8k82p/branch/master?svg=true)](https://ci.appveyor.com/project/ripple/attn-server)
-[![codecov](https://codecov.io/gh/ripple/attn-server/branch/master/graph/badge.svg)](https://codecov.io/gh/ripple/attn-server)
+## Table of contents
 
-Attestation Server for XRPL Sidechains
+* [Documentation](#documentation)
+* [Build guide](#build-guide)
+  * [Dependencies](#dependencies)
+    * [Conan inclusion](#conan-inclusion)
+    * [Other dependencies](#other-dependencies)
+  * [Build steps](#build-and-run)
 
-## Table of contents
+## Documentation
 
-* [Dependencies](#dependencies)
-  * [Conan inclusion](#conan-inclusion)
-  * [Other dependencies](#other-dependencies)
-* [Build and run](#build-and-run)
-* [Guide](#guide)
+- [XRPL Sidechains concept](https://xrpl.org/xrpl-sidechains.html)
+- [Cross bridge transactions](https://opensource.ripple.com/docs/xls-38d-cross-chain-bridge/cross-chain-bridges/)
+- [XRPL-Standards documentation](https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0038d-cross-chain-bridge)
 
-## Dependencies
 
-### Conan inclusion
+## Build guide
+### Dependencies
 
-This project depends on conan (v1.5 and higher, v2.0 not supported) to build it's dependencies. See https://conan.io/ to install conan.
+#### Conan inclusion
 
-### Other dependencies
+This project depends on conan (v1.5 and higher, v2.0 not supported) to build it's dependencies. See [conan doc](https://docs.conan.io/1/installation.html) to install conan.
 
-* C++20
+#### Other dependencies
+
+* C++20 compiler (gcc >=11, clang >=13)
 * [cmake](https://cmake.org) - at least 3.20
 
 
-## Build and run
+### Build and run
 
 1) Create a build directory. For example: build
 2) Change to that directory.
@@ -41,22 +44,17 @@ conan profile update settings.arch=x86_64 default
 4) Run conan. The command is:
 
 ``` bash
-conan install -b missing -s build_type=Debug --output-folder . ..
+conan install -b missing -s build_type=Release --output-folder . ..
 ```
 
-(Note: the exact command I use is as follows, but this assumes gcc 12 is used and a gcc12 conan profile is present):
-```bash
-CC=$(which gcc) CXX=$(which g++) conan install -b missing --profile gcc12 -s build_type=Debug --output-folder . ..
-```
-
-5) Create a build file (replace .. with the appropriate directory):
-* 5.1) Default. If you don't have installed rippled - this setup will download and build it.
+5) Create a build file (replace .. with the appropriate directory). 2 pckage system supported - deb and rpm:
+* 5.1 Default. If you have [rippled](https://github.com/XRPLF/rippled/tree/develop) installed by your packet manager - cmake will try to find it. If nothing found - this setup will download rippled and build it.
 ``` bash
-cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE=build/generators/conan_toolchain.cmake ..
+cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE=build/generators/conan_toolchain.cmake -DPKG=deb ..
 ```
-* 5.2) If you have rippled build from source you can use it
+* 5.2 If you have [rippled](https://github.com/XRPLF/rippled/tree/develop) build from source you can use it
 ``` bash
-cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE=build/generators/conan_toolchain.cmake -DRIPPLE_SRC_DIR=/home/user/repo/rippled -DRIPPLE_BIN_DIR=/home/user/repo/rippled/build-release ..
+cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE=build/generators/conan_toolchain.cmake -DRIPPLE_SRC_DIR=/home/user/repo/rippled -DRIPPLE_BIN_DIR=/home/user/repo/rippled/build-release -DPKG=deb ..
 ```
 
 6) Build the project:
@@ -70,7 +68,4 @@ make -j $(nproc)
 ``` bash
 ./xbridge_witnessd --conf /home/user/repo/config.json
 ```
-
-## Guide
-
-[Attestation Server Documentation](https://github.com/XRPLF/XRPL-Standards/discussions/92)
+Check for config examples in documenation