Browse Source

Update README.md, cli/README.md files

Serdyukov, Denys 4 years ago
parent
commit
f9f6042e19
2 changed files with 4 additions and 2 deletions
  1. 3 1
      README.md
  2. 1 1
      cli/README.md

+ 3 - 1
README.md

@@ -52,7 +52,7 @@ Packages to install after minimal Ubuntu 19.10 installation:
 sudo apt install qtdeclarative5-dev libboost-all-dev libjsoncpp-dev libreadline-dev libpcap-dev build-essential qml-module-qt-labs-platform libssl-dev
 ```
 
-(NOTE: because of bug in jsoncpp, in the file size field of the gui, all numbers after the decimal point are displayed as 0. This bug occurs in version 1.7.4 and is fixed in 1.9.1 (or possibly earlier))
+(NOTE: Due to a bug in jsoncpp, in the file size field of the GUI, all numbers after the decimal point are displayed as 0. This bug occurs in version 1.7.4 and is fixed in 1.9.1 (or possibly earlier).)
 
 #### Install libtins
 ```
@@ -97,12 +97,14 @@ rm -rf googletest
 ## Build
 CMake is used as build system. It should check which dependency is missing and tell you.
 
+All three compontents can be built together using the top-level CMake file.
 ```
 mkdir build
 cd build
 cmake ..
 make
 ```
+The components can also be built seperately following the same instructions from the `./daemon/`, `./cli/` and `./gui/` directory.
 
 ### Build with tests
 ```

+ 1 - 1
cli/README.md

@@ -18,7 +18,7 @@ Batch mode. A batch file for the CLI must contain commands (as used in regular u
 ### Additional arguments
 
 `--usessl <certfile>`: <br/>
-Used to enable SSL communication with the server using the certificate file specified by the file path <i>&lt;certfile&gt;</i>. Needs to be passed if server is configured to use SSL encryption.
+Used to enable SSL communication with the server using the certificate file specified by the file path <i>&lt;certfile&gt;</i>. Needs to be passed if server is configured to use SSL encryption. Configurations where only one side has SSL encryption enabled are not supported.
 
 `--verbose`: <br/>
 Prints additional output for debugging purposes.