summaryrefslogtreecommitdiffstats
path: root/README.txt
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2020-04-03 11:08:43 +1100
committerChris Johns <chrisj@rtems.org>2020-04-03 11:11:11 +1100
commit3f1622e40ee1daf192792f946db6184c7c9c7c88 (patch)
tree1fff817c865d4121b15ff3cee2f64fc54b7da20f /README.txt
parentedfc90253b449641e3c1e1ab1948015ca90c47c7 (diff)
downloadrtems-docs-3f1622e40ee1daf192792f946db6184c7c9c7c88.tar.bz2
Add virtualenv to the README.txt as the preferred host support.
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt22
1 files changed, 21 insertions, 1 deletions
diff --git a/README.txt b/README.txt
index cdd44fd..9fd2165 100644
--- a/README.txt
+++ b/README.txt
@@ -101,6 +101,26 @@ 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`.
+
+Virtualenv
+~~~~~~~~~~
+
+Create a directory to house the virtualenv, create the envrionment and the
+activate it:
+
+ $ mkdir sphinx
+ $ virtualenv sphinx
+ $ . ./sphinx/bin/activate
+
+The prompt will now change. You can install Sphinx with:
+
+ $ pip install sphinx
+ $ pip install sphinxcontrib-bibtex
+
+When you have finished you enter `deactivate`.
+
Sphinx Per User Install
~~~~~~~~~~~~~~~~~~~~~~~
@@ -190,7 +210,7 @@ Python 3:
By default, CentOS 7 has Python 2.x. Luckily they now have Software
Collections which lets you install and use a "collection" of newer
-software. As root,
+software. As root,
# yum install centos-release-scl
# yum install rh-python36