From c9ac32b1ce157583db00961c7964abd94b4a9271 Mon Sep 17 00:00:00 2001
From: "Bryn M. Reeves" <bmr@redhat.com>
Date: Tue, 18 Oct 2016 13:52:31 +0100
Subject: [docs] document use of --config with in-tree builds

---
 README.md | 28 ++++++++++++++++++++++++----
 1 file changed, 24 insertions(+), 4 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 3f6cbebc..4fb764df 100644
--- a/README.md
+++ b/README.md
@@ -56,11 +56,31 @@ pull requests.
 
 ### Manual Installation
 
+You can simply run from the git checkout now:
 ```
-You can simply run from the git checkout now ==> Ex: sudo ./sosreport -a
-or if you only have python3 installed ==> sudo python3 ./sosreport -a
-to install locally (as root) ==> make install
-to build an rpm ==> make rpm
+$ sudo ./sosreport -a
+```
+
+Or, if you only have python3 installed:
+```
+$ sudo python3 ./sosreport -a
+```
+
+* Note: the `sosreport` command requires a configuration file: if no `sos.conf`
+is present in the `/etc` directory (i.e. no system installation of sos exists),
+use the `--config` option to provide one:
+```
+$ sudo python ./sosreport -a --config ./sos.conf
+```
+
+To install locally (as root):
+```
+# make install
+```
+
+To build an rpm:
+```
+$ make rpm
 ```
 
 ### Pre-built Packaging
-- 
cgit