Skip to content

Commit b3e5464

Browse files
Merge pull request #63 from YosysHQ/update_install_docs
add install instructions to docs
2 parents 0551897 + 2bd69a3 commit b3e5464

File tree

1 file changed

+43
-2
lines changed

1 file changed

+43
-2
lines changed

docs/source/install.rst

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,60 @@ Installing
33

44
Follow the instructions below to install EQY and its dependencies.
55

6+
CAD suite(s)
7+
************
8+
9+
EQY is part of the `Tabby CAD Suite
10+
<https://www.yosyshq.com/tabby-cad-datasheet>`_ and the `OSS CAD Suite
11+
<https://github.com/YosysHQ/oss-cad-suite-build>`_! The easiest way to use sby
12+
is to install the binary software suite, which contains all required
13+
dependencies, including Yosys, SBY, and all its solvers.
14+
15+
* `Contact YosysHQ <https://www.yosyshq.com/contact>`_ for a `Tabby CAD Suite
16+
<https://www.yosyshq.com/tabby-cad-datasheet>`_ Evaluation License and
17+
download link
18+
* OR go to https://github.com/YosysHQ/oss-cad-suite-build/releases to download
19+
the free OSS CAD Suite
20+
* Follow the `Install Instructions on GitHub
21+
<https://github.com/YosysHQ/oss-cad-suite-build#installation>`_
22+
23+
Make sure to get a Tabby CAD Suite Evaluation License for industry-grade
24+
SystemVerilog and VHDL parsers!
25+
26+
For more information about the difference between Tabby CAD Suite and the OSS
27+
CAD Suite, please visit https://www.yosyshq.com/tabby-cad-datasheet.
28+
29+
Installing from source
30+
**********************
31+
632
Prerequisites
733
-------------
834

9-
TBD
35+
EQY requires a matching version of `Yosys <https://github.com/YosysHQ/yosys>`_.
36+
We use `GitHub tags <https://github.com/YosysHQ/eqy/tags>`_ to indicate that a
37+
commit has been confirmed to work with that Yosys release version.
38+
39+
Parts of EQY are Yosys plugins. To be able to load the plugins, they must be
40+
compiled in the same environment as the Yosys binary you are using. If you
41+
would like to build EQY from source but use a precompiled Yosys binary, you can
42+
use the `Tabby CAD Plugin Build docker environment
43+
<https://github.com/YosysHQ-GmbH/tabby-cad-plugin-build>`_ to compile the EQY
44+
plugins (the environment works for both Tabby and OSS CAD Suite Yosys).
45+
46+
To use ``[strategy sby]``, you also need to have a
47+
`matching version <https://github.com/YosysHQ/sby/tags>`_ of
48+
`SBY <https://github.com/YosysHQ/sby/>`_ installed, as well as the solvers you
49+
want to use.
1050

1151
EQY
1252
---
1353

14-
https://github.com/YosysHQ/eqy
54+
Use these commands to build and install EQY:
1555

1656
.. code-block:: text
1757
1858
git clone https://github.com/YosysHQ/eqy.git eqy
1959
cd eqy
60+
make
2061
sudo make install
2162

0 commit comments

Comments
 (0)