aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTristan Gingold <tgingold@free.fr>2016-01-18 08:04:53 +0100
committerTristan Gingold <tgingold@free.fr>2016-01-19 19:54:41 +0100
commit0474843607d5566bba92ba3b6e5674ddb33e4dc8 (patch)
treea69186c8e4870cb00cf424782d407d85c1b6747e /README.md
parent77ef3e82086b18c063b9b28032becb9ed3e7630e (diff)
downloadghdl-0474843607d5566bba92ba3b6e5674ddb33e4dc8.tar.gz
ghdl-0474843607d5566bba92ba3b6e5674ddb33e4dc8.tar.bz2
ghdl-0474843607d5566bba92ba3b6e5674ddb33e4dc8.zip
Use markdown for readme.
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/README.md b/README.md
index ffed7af33..067f82a86 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,5 @@
+# GHDL
+
This directory contains the sources of GHDL, the VHDL simulator.
GHDL is not an interpreter: it generates machine code from your design,
@@ -21,8 +23,7 @@ terms; see the individual source files for details.
Doc is available on http://ghdl.readthedocs.org/en/latest/index.html
-Building GHDL (Short instructions)
-**********************************
+## Building GHDL (Short instructions)
If you aren't on linux, see below for full instructions.
@@ -32,8 +33,10 @@ libre.adacore.com, untar and run the doinstall script). You also need
zlib (for Debian or Ubuntu: install zlib1g-dev package).
In the GHDL source directory, configure and build:
+```sh
$ ./configure --prefix=/usr/local
$ make
+```
At that place, you can already use the 'ghdl_mcode' built in the directory.
You can also install GHDL (the executable is installed as 'ghdl'):
@@ -41,7 +44,6 @@ $ make install
That's all!
-Build GHDL (Long instructions)
-******************************
+## Build GHDL (Long instructions)
See BUILD.txt