From 89e16b0c0202899486d4952cdd0017a1ebb7db9e Mon Sep 17 00:00:00 2001 From: Guillaume Mazoyer Date: Thu, 25 Sep 2014 17:51:51 +0200 Subject: Add documentation section in README.md. --- README.md | 6 ++++++ includes/config.defaults.php | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f372781..c6a64a1 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,12 @@ Copy the configuration **config.php.example** file to create a **config.php** file. It contains all the values (PHP variables) used to customize the looking glass. +## Documentation + +An up-to-date (hopefully) documentation is available in the **docs/** +directory. It gives enough details to setup the looking glass, to configure it +and to prepare your routers. + ## License Looking Glass is released under the terms of the GNU GPLv3. Please read the diff --git a/includes/config.defaults.php b/includes/config.defaults.php index 4272bcc..038d661 100644 --- a/includes/config.defaults.php +++ b/includes/config.defaults.php @@ -28,7 +28,7 @@ $config = array( // Logs 'logs' => array( - // Logs file when commands will be written + // Logs file where commands will be written 'file' => '/var/log/looking-glass.log', // Format for each logged command (%D is for the time, %R is for the // requester IP address, %H is for the host and %C is for the command) -- cgit v1.2.3