aboutsummaryrefslogtreecommitdiffstats
path: root/doc/getting
diff options
context:
space:
mode:
authorPatrick Lehmann <Patrick.Lehmann@tu-dresden.de>2017-03-04 17:35:44 +0100
committertgingold <tgingold@users.noreply.github.com>2017-12-10 12:02:05 +0100
commitdf245f9d30e4822d500b519cf7a2eb066f4dfebc (patch)
tree592690a38a0d198d48977632a9ed5b58f9ace676 /doc/getting
parent28d9ddf0e2aff8fe6937949f54285cae9ee478a7 (diff)
downloadghdl-df245f9d30e4822d500b519cf7a2eb066f4dfebc.tar.gz
ghdl-df245f9d30e4822d500b519cf7a2eb066f4dfebc.tar.bz2
ghdl-df245f9d30e4822d500b519cf7a2eb066f4dfebc.zip
Fixed headlines (1).
Diffstat (limited to 'doc/getting')
-rw-r--r--doc/getting/Building.rst22
-rw-r--r--doc/getting/Docker.rst16
2 files changed, 19 insertions, 19 deletions
diff --git a/doc/getting/Building.rst b/doc/getting/Building.rst
index 9df115f3c..28ccea0c1 100644
--- a/doc/getting/Building.rst
+++ b/doc/getting/Building.rst
@@ -81,7 +81,7 @@ Directory structure
- The code in dist/windows/mcode is special code needed to build mcode in windows. mcode is supported on Linux (32/64-bit) and Windows (32-bit).
Mcode backend
-=================
+=============
This is the most simple procedure, because it requires the least dependencies and configuration options.
@@ -94,12 +94,12 @@ GNU/Linux
- That's all!
Windows MinGW 32/64
-----------------
+-------------------
.. TODO:: For example, on Windows, you may want to set it to :samp:`--prefix=/c/Program Files (x86)/GHDL` .
Windows GNAT GPL (32 only)
-----------------
+--------------------------
.. TODO::
Note: this was tested with Windows XP SP2 familly edition.
@@ -107,10 +107,10 @@ Windows GNAT GPL (32 only)
The Ada95 GNAT compiler (GNAT GPL 2005 is known to work), along with NSIS to create the installer. Then unzip, edit winbuild to use correct path for makensis, and run winbuild. The installer is in the windows directory.
LLVM backend
-=================
+============
GNU/Linux
-----------------
+---------
You need to install LLVM (usually depends on :samp:`libedit`, see :ghdlsharp`29`). The supported versions are 3.5 till 3.9, but debugging is only supported with LLVM 3.5.
@@ -121,13 +121,13 @@ You need to install LLVM (usually depends on :samp:`libedit`, see :ghdlsharp`29`
- Then build with :samp:`make` and install with :samp:`make install`.
Mac OS?
-----------------
+-------
Windows MinGW 32/64
-----------------
+-------------------
GCC backend
-=================
+===========
.. TODO::
@@ -142,7 +142,7 @@ GCC backend
$ make grt.links # Locally install the GHDL runtime
GNU/Linux
-----------------
+---------
- First configure GHDL, specify GCC source dir and :samp:`prefix` (replace :samp:`/usr/local` with your desired installation directory)::
@@ -175,7 +175,7 @@ GNU/Linux
make install
Windows?
-----------------
+--------
.. TODO:
@@ -199,7 +199,7 @@ Windows?
.. _test_suites:
Test suites
-=================
+===========
.. TODO::
diff --git a/doc/getting/Docker.rst b/doc/getting/Docker.rst
index 5759739b0..6ba61dbd8 100644
--- a/doc/getting/Docker.rst
+++ b/doc/getting/Docker.rst
@@ -1,35 +1,35 @@
.. _DOCKER:
Docker containers
-#############
+#################
* :ghdlsharp:`270`
* :ghdlsharp:`272`
* :ghdlsharp:`297`
What is docker? A primer
-=================
+========================
Where are images hosted?
-=================
+========================
docker-hub
ghdl-tools
Dockerfiles
Launch options
-=================
+==============
With(out) shared folder
-----------------
+-----------------------
Interactive/daemon
-----------------
+------------------
Shrinking
-----------------
+---------
Additional tools, with(out) GUI
-----------------
+-------------------------------
GtkWave, PoC, VUnit, OSVVM, UVVM \ No newline at end of file