aboutsummaryrefslogtreecommitdiffstats
path: root/doc/index.rst
blob: 8cddac6bf4691670366d5e4601662dfd02ab0565 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
.. exec::
   from helpers import createShields
   createShields()

GHDL
####

.. raw:: html

   <p style="text-align: center;">
     <a title="GitHub Repository" href="https://github.com/ghdl/ghdl"><img src="https://img.shields.io/badge/-ghdl/ghdl-323131.svg?longCache=true&style=flat-square&logo=github"></a><!--
     -->
     <a title="Talk to us on Gitter" href="https://gitter.im/ghdl1/Lobby"><img src="https://img.shields.io/badge/chat-on%20gitter-4db797.svg?longCache=true&style=flat-square&logo=gitter&logoColor=fff"></a><!--
     -->
     <a title="GNU General Public License 2" href="Licenses.html"><img src="https://img.shields.io/badge/code%20license-GPLv2-bd0000.svg?longCache=true&style=flat-square&label=license&logo=gnu"></a><!--
     -->
     <a title="Creative Commons Attribution-ShareAlike 4.0" href="Licenses.html"><img src="https://img.shields.io/badge/doc%20license-CC--BY--SA--4.0-bf7600.svg?longCache=true&style=flat-square&logo=Creative%20Commons&logoColor=fff"></a><!--
     -->
     <a title="Latest release" href="http://ghdl.rtfd.io"><img src="https://img.shields.io/github/release/ghdl/ghdl.svg?longCache=true&style=flat-square&label=latest%20release"></a><!--
     -->
   </p>

   <p style="text-align: center; font-weight: 700; font-size: 125%; margin: 24px 0;">
   GHDL: free and open-source analyzer, compiler, simulator and (experimental) synthesizer for VHDL
   </p>

.. only:: html

   News
   ****

   02.02.2021 - `GHDL v1.0 was released <https://github.com/ghdl/ghdl/milestone/9?closed=1>`__
   ============================================================================================

   31.01.2021 - GHDL v1.0.0rc1 was tagged
   ======================================

   * Python bindings were overhauled and renamed to ``pyGHDL``. Three modules are included: ``libghdl``, ``lsp`` and ``dom``.

     * The utility scripts in the codebase were moved into subdir ``scripts``: CI, binding generation, vendors, etc.

   * Repository `ghdl/extended-tests <https://github.com/ghdl/extended-tests>`__ was created for testing `vendors` build scripts.

   * The logo was updated (org, ghdl/ghdl, ghdl/docker and ghdl/ghdl-cosim).

   * Assets are not added to releases or pre-releases anymore. Users should use package managers or nightly assets.

   21.05.2020 - Nightly build assets available
   ===========================================

   * After each successful CI run of branch ``master``, packages are published as assets of pre-release `nightly <https://github.com/ghdl/ghdl/releases/tag/nightly>`__.
   * GitHub Action `ghdl/setup-ghdl-ci <https://github.com/ghdl/setup-ghdl-ci>`__ was created, to allow easy installation of
     nightly GHDL assets in GitHub Actions workflows.

   09.05.2020 - New repositories and a wiki were created
   =====================================================

   * The plugin for Yosys was moved from `tgingold/ghdlsynth-beta <https://github.com/tgingold/ghdlsynth-beta>`__ to
     `ghdl/ghdl-yosys-plugin <https://github.com/ghdl/ghdl-yosys-plugin>`__.
   * Repository `ghdl/ghdl-cosim <https://github.com/ghdl/ghdl-cosim>`__ was created. It contains documentation and code
     examples related to VHPIDIRECT, VPI and SystemC. See :ref:`COSIM` and `Previous work and future ideas <https://github.com/ghdl/ghdl-cosim/issues/1>`__.
   * A `Wiki <https://github.com/ghdl/ghdl/wiki>`__ was created. The roadmap and ideas for documentation and internship
     programs were moved there. If you want to contribute anyhow, `have a look <https://github.com/ghdl/ghdl/wiki>`__!

   28.02.2020 - `GHDL v0.37 was released <https://github.com/ghdl/ghdl/milestone/8?closed=1>`__
   ============================================================================================

   The major changes are:

      * Experimental support of synthesis (either with --synth or with
	the Yosys plugin).
      * Fixes and improved support of vhdl 2008.
      * Last version that supports the Mentor variation of
	std_logic_arith.  The Synopsys one is still available.

   03.03.2019 - `GHDL v0.36 was released <https://github.com/ghdl/ghdl/milestone/7?closed=1>`__
   ============================================================================================

   23.02.2019 - GHDL v0.36-rc1 was released
   ========================================

   The major improvements are:

      * more support of unbounded arrays and records
      * support of UVVM and Vunit

   29.11.2018 - GHDL 20181129 was released
   =======================================

   20.12.2017 - A new GitHub organization was created
   ==================================================

   A new GitHub organization is created and the main repo is moved from `github.com/tgingold/ghdl <https://github.com/tgingold/ghdl>`__ to
   `github.com/ghdl/ghdl <https://github.com/ghdl/ghdl>`__. Old refs will continue working, because permanent redirects are set up. However, we suggest
   every contributor to update the remote URLs in their local clones.

   14.12.2017 - `GHDL 0.35 was released <https://github.com/ghdl/ghdl/milestone/3?closed=1>`__
   ===========================================================================================

   15.08.2017 - `GHDL 0.34 was released <https://github.com/ghdl/ghdl/milestone/1?closed=1>`__
   ===========================================================================================

   23.10.2015 - GHDL 0.33 was released
   ===================================

.. only:: latex

   .. rubric:: 02.02.2021 - GHDL v1.0 was released.

   .. rubric:: 31.01.2021 - GHDL v1.0.0rc1 was tagged.

   .. rubric:: 21.05.2020 - Nightly build assets available.

   .. rubric:: 09.05.2020 - New repositories and a wiki were created.

   .. rubric:: 28.02.2020 - GHDL v0.37 was released.

   .. rubric:: 03.03.2019 - GHDL v0.36 was released.

   .. rubric:: 23.02.2019 - GHDL v0.36-rc1 was released.

   .. rubric:: 29.11.2018 - GHDL 20181129 was released.

   .. rubric:: 20.12.2017 - A new GitHub organization was created.

   .. rubric:: 14.12.2017 - GHDL 0.35 was released.

   .. rubric:: 15.08.2017 - GHDL 0.34 was released.

   .. rubric:: 23.10.2015 - GHDL 0.33 was released.

.. toctree::
   :caption: Introduction
   :hidden:

   about
   getting
   contribute
   licenses

.. raw:: latex

   \part{Usage}

.. toctree::
   :caption: GHDL usage
   :hidden:

   quick_start/index
   using/InvokingGHDL
   using/Simulation
   using/Synthesis
   using/CommandReference
   using/ImplementationOfVHDL
   using/ImplementationOfVITAL

.. raw:: latex

   \part{Development}

.. toctree::
   :caption: Development
   :hidden:

   development/Directories
   Building GHDL <development/building/index>
   Python Interfaces <pyGHDL/pyGHDL>
   ghw/index
   development/Debugging
   development/CodingStyle
   development/Scripts

.. raw:: latex

   \part{Internals}

.. toctree::
   :caption: Internals
   :hidden:

   internals/index
   internals/Frontend
   internals/AST
   internals/RTI
   gnatdoc/index

.. raw:: latex

   \part{Index}

.. toctree::
   :caption: Index
   :hidden:

   genindex
   py-modindex