diff options
| author | 1138-4EB <1138-4EB@users.noreply.github.com> | 2017-02-20 04:21:24 +0100 |
|---|---|---|
| committer | tgingold <tgingold@users.noreply.github.com> | 2017-12-10 12:02:05 +0100 |
| commit | bfb47bd712511b42c66094c649fee89cd621fe32 (patch) | |
| tree | fa2100400778266fdfce51e152513cb5233f7518 /doc/index.rst | |
| parent | 7423f48c2d85c8439181a4213ae65b2c1ed833af (diff) | |
| download | ghdl-bfb47bd712511b42c66094c649fee89cd621fe32.tar.gz ghdl-bfb47bd712511b42c66094c649fee89cd621fe32.tar.bz2 ghdl-bfb47bd712511b42c66094c649fee89cd621fe32.zip | |
README.md, index, WhatIsVHDL, WhatIsGHDL ready for review.
Add shortcuts for shields in a single file and include it where used.
Create base64 GitHub and Travis-CI logos with b64.io and add them to self-created shields. Replace gitter with shield.io's variant.
Start rewriting <Contributing>
Diffstat (limited to 'doc/index.rst')
| -rw-r--r-- | doc/index.rst | 46 |
1 files changed, 9 insertions, 37 deletions
diff --git a/doc/index.rst b/doc/index.rst index 55bc93101..38f2e9a3b 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,44 +1,16 @@ -This manual is the user and reference manual for GHDL. It does not contain an -introduction to VHDL. Thus, the reader should have at least a basic knowledge -of VHDL. A good knowledge of VHDL language reference manual (usually called -LRM) is a plus. - -.. only:: html - - .. raw:: html - - <hr /> +.. include:: shields.txt - .. image:: /_static/logos/GitHub-Mark-32px.png - :scale: 60 - :target: https://www.github.com/tgingold/ghdl - :alt: Source Code on GitHub - .. image:: https://badges.gitter.im/ghdl/ghdl1.svg - :target: https://gitter.im/ghdl/ghdl1 - :alt: Join +|SHIELD:gh-logo| |SHIELD:gitter| |SHIELD:code-lic| |SHIELD:doc-lic| |br| |SHIELD:travis-ci| |SHIELD:appveyor| |SHIELD:tag| |SHIELD:release| - .. raw:: html - - <br /> - - .. image:: https://travis-ci.org/tgingold/ghdl.svg?branch=master - :target: https://travis-ci.org/tgingold/ghdl - :alt: Build status by Travis-CI - .. image:: https://ci.appveyor.com/api/projects/status/r5dtv6amsppigpsp/branch/release?svg=true - :target: https://ci.appveyor.com/project/Paebbels/poc/branch/release - :alt: Build status by AppVeyor - .. image:: https://img.shields.io/github/tag/tgingold/ghdl.svg?style=flat - :alt: Latest tag - .. image:: https://img.shields.io/github/release/tgingold/ghdl.svg?style=flat - :target: https://github.com/tgingold/ghdl/releases - :alt: Latest release - .. image:: https://img.shields.io/github/license/tgingold/ghdl.svg?style=flat - :target: intro/Copyrights.html - :alt: GNU General Public License 2 +------------------------------------ - .. raw:: html +GHDL Documentation +################## - <hr /> +This manual is the user and reference manual for GHDL. It does not contain an +introduction to VHDL. Thus, the reader should have at least a basic knowledge +of VHDL. A good knowledge of VHDL language reference manual (usually called +LRM) is a plus. .. only:: html |