summaryrefslogtreecommitdiffstats
path: root/README.txt
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2020-08-11 12:33:03 +1000
committerChris Johns <chrisj@rtems.org>2020-08-12 11:06:23 +1000
commitb71f7f6960a628c0e1c930b5769d19c5957a6998 (patch)
treead8d2b2fcac1cebd5b85be3ffe4cb8ad3f8edcb4 /README.txt
parent441d2e15f3566919eac29b0e1a22cb59a31051f9 (diff)
downloadrtems-docs-b71f7f6960a628c0e1c930b5769d19c5957a6998.tar.bz2
user, README: Add Python script host set up information
- Add Python3 and venv to the README - Add a section on how to set up a host if the python command is not available. Update #4037
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt18
1 files changed, 12 insertions, 6 deletions
diff --git a/README.txt b/README.txt
index ce30505..03f57ed 100644
--- a/README.txt
+++ b/README.txt
@@ -101,14 +101,20 @@ command.
Please add your host as you set it up.
-The best environment to use is `virtualenv`. It can create a specific python
-environment using `pip`.
+The best results are produced with Python3 and a virtual environment`. It can
+create a specific python environment using `pip`.
-Virtualenv
-~~~~~~~~~~
+Virtual Environment
+~~~~~~~~~~~~~~~~~~~
+
+Create a directory to house the virtual environment, create the envrionment
+and the activate it. This example assumes Python3 and the `venv` module:
+
+ $ mkdir sphinx
+ $ python3 -m venv sphinx
+ $ . ./sphinx/bin/activate
-Create a directory to house the virtualenv, create the envrionment and the
-activate it:
+Alternatively you can use the `virtualenv` command:
$ mkdir sphinx
$ virtualenv sphinx