path: root/README.txt
diff options
authorChris Johns <>2016-11-09 17:08:05 +1100
committerChris Johns <>2016-11-09 17:08:05 +1100
commit9330bfbaa7e7855c4b1caa75de78c97197d45733 (patch)
tree395712f2db02d74d32a9b75ca322e5eeb2b3d512 /README.txt
parentfilesystem: Fix header levels. (diff)
waf: Users without the extra fonts need to use '--disable-extra-fonts' to build PDF.
Diffstat (limited to 'README.txt')
1 files changed, 7 insertions, 2 deletions
diff --git a/README.txt b/README.txt
index 190337e..e0c06c4 100644
--- a/README.txt
+++ b/README.txt
@@ -18,7 +18,7 @@ The RTEMS Documentation output formats are:
PDF - Single PDF per manual.
SIngle HTML - Single HTML, one file per manual.
-The PDF format is cerated using Latex and that uses texlive packages. This
+The PDF format is created using Latex and that uses texlive packages. This
exposes us to the complex world of Latex however the quality of the documents
created is worth it.
@@ -229,12 +229,17 @@ Note: waf-1.9.5 is a little noisy when running tex builds and tests. I hope
To build enter in the top directory:
- $ ./waf configure [--pdf] [--singlehtml] [--prefix] [--sphinx-verbose]
+ $ ./waf configure [--pdf] [--singlehtml] [--prefix] \
+ [--sphinx-verbose] [--disable-extra-fonts]
$ ./waf
The '--pdf' and '--singlehtml' options can be added to configure to build those
output formats.
+The '--disable-extra-fonts' allows you to build PDF documents with out the
+fonts we use for a better quality document. Use this option to build without
+needing the extra fonts accepting you will get poor quality documents.
To build and install to a specific location:
$ ./waf configure --prefix=/foo/my/location