Skip to content

Commit 6b3f2fd

Browse files
Docs: Installation instructions
Add warning for Cygwin. Add commented out instructions for MSYS2 that I tried to get to work but ran into build errors.
1 parent b9d73d0 commit 6b3f2fd

File tree

1 file changed

+30
-3
lines changed

1 file changed

+30
-3
lines changed

docs/source/getting_started/installation.rst

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -130,24 +130,51 @@ or MacPorts:
130130
.. code:: console
131131
132132
sudo port install bison flex readline gawk libffi graphviz \
133-
pkgconfig python36 boost zlib tcl
133+
pkgconfig python311 boost zlib tcl
134134
135135
On FreeBSD use the following command to install all prerequisites:
136136

137137
.. code:: console
138138
139139
pkg install bison flex readline gawk libffi graphviz \
140-
pkgconf python3 python36 tcl-wrapper boost-libs
140+
pkgconf python311 tcl-wrapper boost-libs
141141
142142
.. note:: On FreeBSD system use gmake instead of make. To run tests use:
143143
``MAKE=gmake CXX=cxx CC=cc gmake test``
144144

145145
For Cygwin use the following command to install all prerequisites, or select these additional packages:
146146

147-
.. code::
147+
.. code:: console
148148
149149
setup-x86_64.exe -q --packages=bison,flex,gcc-core,gcc-g++,git,libffi-devel,libreadline-devel,make,pkg-config,python3,tcl-devel,boost-build,zlib-devel
150150
151+
.. warning::
152+
153+
As of this writing, Cygwin only supports up to Python 3.9.16 while the
154+
minimum required version of Python is 3.11. This means that Cygwin is not
155+
compatible with many of the Python-based frontends. While this does not
156+
currently prevent Yosys itself from working, no guarantees are made for
157+
continued support. It is instead recommended to use Windows Subsystem for
158+
Linux (WSL) and follow the instructions for Ubuntu.
159+
160+
..
161+
For MSYS2 (MINGW64):
162+
163+
.. code:: console
164+
165+
pacman -S bison flex mingw-w64-x86_64-gcc git libffi-devel libreadline-devel make pkg-config python3 tcl-devel mingw-w64-x86_64-boost zlib-devel
166+
167+
Not that I can get this to work; it's failing during ld with what looks like
168+
math library issues: ``multiple definition of `tanh'`` and
169+
``undefined reference to `__imp_acosh'``, as well as issues in `aiger2` with
170+
``seekg`` et al not being available.
171+
172+
.. note::
173+
174+
The ``config-msys2-64`` target uses the ``mingw-w64-x86_64-`` prefixed
175+
compiler in order to allow compiled exe files to be run without an MSYS2
176+
shell.
177+
151178
Build configuration
152179
^^^^^^^^^^^^^^^^^^^
153180

0 commit comments

Comments
 (0)