summaryrefslogtreecommitdiffstats
path: root/README.txt
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2017-03-27 10:31:13 +1100
committerChris Johns <chrisj@rtems.org>2017-03-27 10:31:13 +1100
commit33989b6bf63afe7ec04649f6b9e96294026fda64 (patch)
treee71d33490c9ccf7b925d13f4f91185a789d948c2 /README.txt
parent02635812f63bba63e679b55737f6feffaec3f7a0 (diff)
downloadrtems-docs-33989b6bf63afe7ec04649f6b9e96294026fda64.tar.bz2
Add Windows build details.
Actually include the quoting fix for Windows.
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.txt b/README.txt
index aeb6ca5..809536c 100644
--- a/README.txt
+++ b/README.txt
@@ -65,6 +65,29 @@ and sphinx:
export PATH=/usr/local/texlive/2016/bin/i386-linux/:${PATH}
export PATH=${HOME}/.local/bin:${PATH}
+Windows
+~~~~~~~
+
+To build the documentation on Windows you need to install an offical Python
+build from https://www.python.org/. We suggest you install a recent 2.7 series
+64bit build. The versions 2.7.9 and after include pip.
+
+Note: you cannot use the MSYS2 versions of Python because the pip libraries
+that contain C or C++ code are built with MSVC libraries and cannot integrate
+with the MSYS2 built python.
+
+The following assumes Python is installed to its default path of C:\Python27.
+
+Open an MSYS2 terminal window and add the needed paths to Python and its
+scripts:
+
+ $ export PATH=/c/Python27/Scripts:/c/Python27:$PATH
+
+Install Sphinx and any needed extensions:
+
+ $ pip install sphinx
+ $ pip install sphinxcontrib-bibtex
+
FreeBSD
~~~~~~~