From efb8b7c3ae208d5bd45a1a030ccb6f6d61b112c9 Mon Sep 17 00:00:00 2001
From: Julien Dessaux
Date: Thu, 14 Mar 2019 16:44:11 +0100
Subject: Fixed build problem with SESSION_RECORDING flag set to OFF and
 updated the readme

---
 README.md | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index bf4eb9c..6337b47 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,9 @@ SSH bastion that features transparent connection and session recording.
 
 This project is inspired by https://github.com/moul/sshportal. I wrote this implementation to work around the fact that I couldn't get the go ssh lib
 to work properly with non interactive sessions, the bug has been open for a long time and I tend to belive it cannot be fixed
-(https://github.com/moul/sshportal/issues/55). This one does work properly with non interactive sessions, which allows transparent ansible usage through
-the bastion.
+(https://github.com/moul/sshportal/issues/55).
+
+This bastion project does work properly with non interactive sessions, which allows transparent ansible usage through the bastion.
 
 ## Contents
 
@@ -39,10 +40,14 @@ make install
 ```
 
 You can customise the build with the following cmake flags :
-- SESSION_RECORDING
 
-For exemple this disables session recording :
-`cmake .. -DSESSION_RECORDING=OFF`
+- `CMAKE_BUILD_TYPE` : Debug|Release|RelWithDebInfo|MinSizeRel, defaults to Release
+- `CMAKE_INSTALL_PREFIX` : path, defaults to `/usr/local`
+- `SESSION_RECORDING` : ON|OFF, defaults to ON
+
+For exemple this disables session recording for a debug build and install it under /usr :
+
+`cmake .. -DCMAKE_BUILD_TYPE=Debug -D CMAKE_INSTALL_PREFIX=/usr -DSESSION_RECORDING=OFF`
 
 ## Usage
 
-- 
cgit v1.2.3