aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorAaron LI <aly@aaronly.me>2017-07-21 10:34:56 +0800
committerAaron LI <aly@aaronly.me>2017-07-21 10:34:56 +0800
commitd31eec7033f8a511a450f966b35866ed7570f8fb (patch)
treef7c53c2781c52212ee37903eb2e1c330caf7e94c /README.rst
parentb3219ca75b4e566f904f2c57997edc5bdde47ea9 (diff)
downloadfg21sim-d31eec7033f8a511a450f966b35866ed7570f8fb.tar.bz2
README.rst: update "development" section with DEBUG info
Signed-off-by: Aaron LI <aly@aaronly.me>
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index e4bf1c1..015031b 100644
--- a/README.rst
+++ b/README.rst
@@ -95,12 +95,15 @@ Installation
Development
-----------
To ease development and tests, you may want to install this package in
-an **editable state**, instead of using the *virtual environment*::
+an **editable state**::
$ cd fg21sim/
$ pip3 install --user -r requirements.txt
$ pip3 install --editable .
+In addition, setting the environment variable ``DEBUG_FG21SIM`` forces
+this package running with ``DEBUG`` logging level.
+
Documentations
--------------