summaryrefslogtreecommitdiffstats
path: root/README.txt
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2018-05-20 08:32:42 +1200
committerChris Johns <chrisj@rtems.org>2018-11-03 16:36:32 +1100
commit8b67c9135cb78abc394d43e449ccc6387c73f014 (patch)
tree6d4a21905a43cc4f476a1d6013baf151ce39ade5 /README.txt
parent21c1a4492a6c437d057c3af605278e9ba5edcac0 (diff)
downloadrtems-docs-8b67c9135cb78abc394d43e449ccc6387c73f014.tar.bz2
user: Add RTEMS executable and test documentation.
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt43
1 files changed, 41 insertions, 2 deletions
diff --git a/README.txt b/README.txt
index 203c45d..299c94e 100644
--- a/README.txt
+++ b/README.txt
@@ -22,6 +22,8 @@ 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.
+Images can be created from source using PlantUML and Ditaa.
+
Production Quality Hosts
------------------------
@@ -36,12 +38,50 @@ The hosts which produce production quality is:
NOTE: RedHat Enterprise Linux (RHEL) and Fedora should be the same as CentOS.
+Images
+------
+
+All images should be placed int he 'images' directory and referenced from the
+ReST with a relative path. This lets us shared and control images.
+
+We prefer being able to build images from source. This is not always possible
+so SVG format is preferred with generated PNG images so make sure the quality
+is consistent when building PDF output.
+
+We support the PlantUML image language. The PlantUML home page is:
+
+ http://plantuml.com/
+
+The page as a link to an 'online demo server' you can use to create images
+rathre than installing PlantUML. Save you source then View and save the PNG
+format image. The PlantUML language reference guide is:
+
+ http://plantuml.com/PlantUML_Language_Reference_Guide.pdf
+
+And the web site has online documentation. The image source extension is
+'.puml'.
+
+We also support Ditaa image language. The Ditaa home page is:
+
+ http://ditaa.sourceforge.net/
+
+The home page contain the language options. The PlantUML online demo server
+supports Ditaa so use that resource as an online tool. The Ditaa image source
+extension is '.ditaa'.
+
+You do not need PlantUML or Ditaa install to build our documentation. The
+online resources can be used. Save the source and the generated PNG file in the
+same directory under 'images'.
+
Host Setup
----------
HTML builds directly with Sphinx, PDF requires a full Latex (texlive) install,
and building a Single HTML page requires the 'inliner' tool. The
-sphinxcontrib-bibtex extension is mandatory.
+sphinxcontrib-bibtex extension is mandatory. PlantUML requres the Node.js
+package called 'nde-plantuml' which installs the 'puml' command and Ditaa needs
+the 'ditaa' command and package. Ditaa images are built using the 'puml'
+command.
Please add your host as you set it up.
@@ -182,7 +222,6 @@ PATH:
export PATH=/usr/local/texlive/2016/bin/i386-linux/:${PATH}
export PATH=${HOME}/.local/bin:${PATH}
-
Arch Linux
~~~~~~~~~~