updating readme

ukaea · Oct 23, 2024 · 83e73fa · 83e73fa
1 parent 90dce77
commit 83e73fa
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -9,15 +9,19 @@ remote server, or as fat-client API where both the client access and plugin func
 
 ## Licence
 
-See LICENCE.txt for details.
+UDA is licenced under an Apache 2.0 licence. See [LICENCE.txt](https://github.com/ukaea/UDA/blob/main/LICENCE.txt) for details.
+
+## documentation
+
+See the github pages for current [Docs](https://ukaea.github.io/UDA/)
 
 ## Getting UDA
 
 The source code can be downloaded from:
 
     https://github.com/ukaea/UDA/releases/
 
-The UDA git repository can be cloned:
+The UDA git repository can be cloned from:
 
     git clone git@github.com:ukaea/UDA.git
 
@@ -33,9 +37,15 @@ For any other use cases please see the documentation to build from source [here]
 
 ## Building UDA Server from source
 
+There are some notes available [here](https://ukaea.github.io/UDA/server_installation/) in the documentation. 
+
+Note that the most up-to-date build script will be the one used for testing in the github CI tests [here](https://github.com/ukaea/UDA/blob/release/2.8.0/.github/workflows/cmake.yml). This will contain the relevant buld steps for Ubuntu and MacOS. There are also some dockerfiles available [here](https://github.com/ukaea/UDA/tree/release/2.8.0/docker) which will show the build steps for some other Linux flavours. 
+
+An example installation for ubuntu 22.10 would be as follows.
+
 ### Dependencies
 
-UDA requires the following to avail in order to build:
+UDA requires the following to packages in order to build:
 
 | Name | Version | Required For |
 | --- | --- | --- |
@@ -49,9 +59,8 @@ UDA requires the following to avail in order to build:
 | LibMemcached | | to enable caching |
 | python | \> 3.0 | Python wrapper |
 
-An example installation for ubuntu 22.10 would be as follows.
 
-Start by install all system-level dependencies.
+Start by installing all system-level dependencies.
 ```sh
 sudo apt update && sudo apt install -y
 git
@@ -71,7 +80,7 @@ python3-pip
 python3-venv
 ```
 
-Configure the cmake project.
+Configure the cmake project
 ```sh
 cmake -G Ninja -B build . \
 -DBUILD_SHARED_LIBS=ON \
@@ -81,6 +90,7 @@ cmake -G Ninja -B build . \
 -DCMAKE_INSTALL_PREFIX=install
 ```
 
+build and install
 ```sh
 cmake --build build -j --config Release --target install
 ```

diff --git a/docs/server_installation.md b/docs/server_installation.md
@@ -14,14 +14,16 @@ nav_order: 4
 | OpenSSL version 1 | 1.1                      |
 | pkg-config        | 0.29                     |
 | libXML2           | 2.10                     |
- | Capnproto         | 0.10                     |
+| Capnproto         | 0.10                     |
 
 ## Supported OSs
 
 The UDA server can been build on Linux and macOS. Note that the server will not run on Windows; only the client installation is supported. 
 
 ## Builing UDA
 
+Note that the most up-to-date build script will be the one used for testing in the github CI tests [here](https://github.com/ukaea/UDA/blob/release/2.8.0/.github/workflows/cmake.yml). This will contain the relevant buld steps for Ubuntu and MacOS. There are also some dockerfiles available [here](https://github.com/ukaea/UDA/tree/release/2.8.0/docker) which will show the build steps for some other Linux flavours. 
+
 **Clone the repo**
 
 ```bash
@@ -32,13 +34,27 @@ git clone git@github.com:ukaea/UDA.git
 
 Cmake configuration options
 
-| Options              | Description |
-|----------------------|-------------|
-| BUILD_SHARED_LIBS    |             |
-| OPENSSL_ROOT_DIR     |             |
-| BOOST_ROOT           |             |
-| CMAKE_INSTALL_PREFIX |             |
-| CMAKE_BUILD_TYPE     |             |
+|Option | Defaullt | Description |
+|------|-----------|-------------|
+|BUILD_SHARED_LIBS:BOOL | ON | Build shared libraries|
+|CMAKE_INSTALL_PREFIX:PATH | /usr/local | Install path prefix, prepended onto install directories.|
+|CMAKE_BUILD_TYPE:STRING | Debug | Choose the type of build, options are: None Debug Release RelWithDebInfo MinSizeRel ...|
+|UDA_SERVER_HOST:STRING | `hostname` | define hostname in server configuration files|
+|UDA_SERVER_PORT:STRING | 56565 | define port number in server configuration files|
+|CLIENT_ONLY:BOOL | ON | Only build UDA client|
+|SERVER_ONLY:BOOL | OFF | Only build UDA server|
+|ENABLE_CAPNP:BOOL | ON | Enable Cap’n Proto serialisation|
+|NO_MEMCACHE:BOOL | ON | Do not attempt to build with libmemcached support|
+|NO_WRAPPERS:BOOL | OFF | Don't build any UDA client wrappers|
+|NO_CLI:BOOL | OFF | Don't build UDA CLI|
+|UDA_CLI_BOOST_STATIC:BOOL | OFF | compile commandline interface with static boost libraries|
+|NO_CXX_WRAPPER:BOOL | OFF | Don't build C++ wrapper|
+|NO_IDL_WRAPPER:BOOL | OFF | Don't build IDL wrapper|
+|FAT_IDL:BOOL | OFF | Build IDL wrapper using fat-client|
+|NO_JAVA_WRAPPER:BOOL | OFF | Don't build Java wrapper|
+|NO_PYTHON_WRAPPER:BOOL | OFF | Don't build Python wrapper|
+
+
 
 ```bash
 export UDA_ROOT=/usr/local