aboutsummaryrefslogtreecommitdiffstats
path: root/doc/getting/Releases.rst
blob: 63284307a8c5c5c661868b7fa201a275b42d7a3b (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
.. _RELEASE:

Releases
########

.. contents:: Contents of this Page
   :local:

.. _RELEASE:packages:

Downloading pre-build packages
******************************

.. |Ubu1204-llvm38| image:: https://img.shields.io/github/downloads/tgingold/ghdl/2017-03-01/ghdl-0.34-dev-llvm-3.8-2017-03-01-ubu1204.tgz.svg
   :target: https://github.com/tgingold/ghdl/releases/download/2017-03-01/ghdl-0.34-dev-llvm-3.8-2017-03-01-ubu1204.tgz
   :alt: ghdl-0.34-dev-llvm-3.5-2017-03-01-ubu1404.tgz
.. |Ubu1404-llvm35| image:: https://img.shields.io/github/downloads/tgingold/ghdl/2017-03-01/ghdl-0.34-dev-llvm-3.5-2017-03-01-ubu1404.tgz.svg
   :target: https://github.com/tgingold/ghdl/releases/download/2017-03-01/ghdl-0.34-dev-llvm-3.5-2017-03-01-ubu1404.tgz
   :alt: ghdl-0.34-dev-llvm-3.5-2017-03-01-ubu1404.tgz
.. |Fed-llvm| image:: https://img.shields.io/github/downloads/tgingold/ghdl/2017-03-01/ghdl-0.34-dev-llvm-2017-03-01-fed.tgz.svg
   :target: https://github.com/tgingold/ghdl/releases/download/2017-03-01/ghdl-0.34-dev-llvm-2017-03-01-fed.tgz
   :alt: ghdl-0.34-dev-llvm-2017-03-01-fed.tgz
.. |Fed-mcode| image:: https://img.shields.io/github/downloads/tgingold/ghdl/2017-03-01/ghdl-0.34-dev-mcode-2017-03-01-fed.tgz.svg
   :target: https://github.com/tgingold/ghdl/releases/download/2017-03-01/ghdl-0.34-dev-mcode-2017-03-01-fed.tgz
   :alt: ghdl-0.34-dev-mcode-2017-03-01-fed.tgz
.. |Win32-mcode| image:: https://img.shields.io/github/downloads/tgingold/ghdl/2017-03-01/ghdl-0.34-dev-mcode-2017-03-01-win32.zip.svg
   :target: https://github.com/tgingold/ghdl/releases/download/2017-03-01/ghdl-0.34-dev-mcode-2017-03-01-win32.zip
   :alt: ghdl-0.34-dev-mcode-2017-03-01-win32.tgz

+--------------+----------+-----------+--------------------+
| OS           | Backend  | Filesize  | Downloads          |
+==============+==========+===========+====================+
| Ubuntu 12.04 | LLVM 3.8 | 13.8 MiB  | |Ubu1204-llvm38|   |
+--------------+----------+-----------+--------------------+
| Ubuntu 14.04 | LLVM 3.5 | 11.9 MiB  | |Ubu1404-llvm35|   |
+--------------+----------+-----------+--------------------+
| Fedora       | LLVM     | 6.58 MiB  | |Fed-llvm|         |
+--------------+----------+-----------+--------------------+
| Fedora       | mcode    | 2.75 MiB  | |Fed-mcode|        |
+--------------+----------+-----------+--------------------+
| Windows x86  | mcode    | 5.25 MiB  | |Win32-mcode|      |
+--------------+----------+-----------+--------------------+



.. _RELEASE:Sources:

Downloading Source Files
************************

.. _RELEASE:Sources:Zip:

Downloading from GitHub
=======================

GHDL can be downloaded as a zip-file from GitHub. See the following table, to
choose your desired git branch.

.. |zip-master| image:: /_static/icons/ZIP.png
   :scale: 40
   :target: https://github.com/tgingold/ghdl/archive/master.zip
   :alt: Source Code from GitHub - 'master' branch.
.. |zip-release| image:: /_static/icons/ZIP.png
   :scale: 40
   :target: https://github.com/tgingold/ghdl/archive/release.zip
   :alt: Source Code from GitHub - 'release' branch.

+----------+------------------------+
| Branch   | Download Link          |
+==========+========================+
| master   | zip-file |zip-master|  |
+----------+------------------------+
| release  | zip-file |zip-release| |
+----------+------------------------+


.. _RELEASE:Sources:GitClone:

Downloading via ``git clone``
=============================

GHDL can be downloaded (cloned) with ``git clone`` from GitHub. GitHub offers
the transfer protocols HTTPS and SSH. You should use SSH if you have a GitHub
account and have already uploaded an OpenSSH public key to GitHub, otherwise
use HTTPS if you have no account or you want to use login credentials.

The created folder :file:`<GitRoot>\\ghdl` is used as :file:`<GHDLRoot>` in
later instructions or on other pages in this documentation.

+----------+----------------------------------------+
| Protocol | GitHub Repository URL                  |
+==========+========================================+
| HTTPS    | https://github.com/tgingold/ghdl.git   |
+----------+----------------------------------------+
| SSH      | ssh://git@github.com:tgingold/ghdl.git |
+----------+----------------------------------------+


On Linux
--------

Command line instructions to clone GHDL onto a Linux machine with HTTPS
protocol:

.. code-block:: Bash

   cd GitRoot
   git clone "https://github.com/tgingold/ghdl.git" ghdl
   cd ghdl
   git remote rename origin github

Command line instructions to clone GHDL onto a Linux machine machine with SSH
protocol:

.. code-block:: Bash

   cd GitRoot
   git clone "ssh://git@github.com:tgingold/ghdl.git" ghdl
   cd ghdl
   git remote rename origin github


On OS X
-------

Please see the Linux instructions.


On Windows
----------

.. NOTE::

   All Windows command line instructions are intended for :program:`Windows PowerShell`,
   if not marked otherwise. So executing the following instructions in Windows
   Command Prompt (:program:`cmd.exe`) won't function or result in errors! See
   the :ref:`Requirements section <GETTING:Require>` on where to
   download or update PowerShell.

Command line instructions to clone GHDL onto a Windows machine with HTTPS
protocol:

.. code-block:: PowerShell

   cd GitRoot
   git clone "https://github.com/tgingold/ghdl.git" ghdl
   cd ghdl
   git remote rename origin github

Command line instructions to clone GHDL onto a Windows machine with SSH
protocol:

.. code-block:: PowerShell

   cd GitRoot
   git clone "ssh://git@github.com:tgingold/ghdl.git" ghdl
   cd ghdl
   git remote rename origin github


---------------------------------------------------------------------

.. TODO::
 
   * Naming:
      * branch ghdl-X.Y
      * tag vX.Y
   * stable, development, nightly
   * Regular: ubuntu-mcode and fedora-llvm (both latest default packages).
   * Distro checking: three distros and three compilers, nine options total. Would you add Debian? Any other?
   * Dependency version checking: single distro and specific compiler and version pairs. Which ones? LLVM 3.5? LLVM3.9? LLVM 4? GGC 4? GCC 5?
   * Release: does it make any sense to realease multiple distro versions, if all of them are compiled with the same dependency version? A side observation is that Fedora's release is half the size of Ubuntu's, even though both are compiled with LLVM 3.8. Why?