occheung
/
artiq
forked from M-Labs/artiq
1
0
Fork 0
Code Pull Requests Activity

docs: update MSYS2 to include offline installer and openocd included by default 

docs: update MSYS2 mingw -> clang

Signed-off-by: Egor Savkin <es@m-labs.hk>
This commit is contained in:
Egor Savkin 2024-05-20 10:21:26 +08:00 committed by Sébastien Bourdeauducq
parent c2d645ed0a
commit 2b31d38084
2 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/manual/installing.rst
View File

@ -154,16 +154,19 @@ This will set your user as a trusted user, allowing the use of any untrusted sub
Installing via MSYS2 (Windows) Installing via MSYS2 (Windows)
------------------------------ ------------------------------
Install `MSYS2 <https://msys2.org>`_, then edit ``C:\MINGW64\etc\pacman.conf`` and add at the end: :: We recommend using our `offline installer <https://nixbld.m-labs.hk/job/artiq/extra-beta/msys2-offline-installer/latest>`_, which contains all the necessary packages and no additional configuration is needed.
After installation, launch ``MSYS2 with ARTIQ`` from the Windows Start menu.
Alternatively, you may install `MSYS2 <https://msys2.org>`_, then edit ``C:\MINGW64\etc\pacman.conf`` and add at the end: ::
[artiq] [artiq]
SigLevel = Optional TrustAll SigLevel = Optional TrustAll
Server = https://msys2.m-labs.hk/artiq-beta Server = https://msys2.m-labs.hk/artiq-beta
Launch ``MSYS2 MINGW64`` from the Windows Start menu to open the MSYS2 shell, and enter the following commands: :: Launch ``MSYS2 CLANG64`` from the Windows Start menu to open the MSYS2 shell, and enter the following commands: ::
pacman -Syy pacman -Syy
pacman -S mingw-w64-x86_64-artiq pacman -S mingw-w64-clang-x86_64-artiq
If your favorite package is not available with MSYS2, contact us using the helpdesk@ email. If your favorite package is not available with MSYS2, contact us using the helpdesk@ email.
@ -259,9 +262,7 @@ OpenOCD can be used to write the binary images into the core device FPGA board's
With Nix, add ``aqmain.openocd-bscanspi`` to the shell packages. Be careful not to add ``pkgs.openocd`` instead - this would install OpenOCD from the NixOS package collection, which does not support ARTIQ boards. With Nix, add ``aqmain.openocd-bscanspi`` to the shell packages. Be careful not to add ``pkgs.openocd`` instead - this would install OpenOCD from the NixOS package collection, which does not support ARTIQ boards.
With MSYS2, install ``openocd`` and ``bscan-spi-bitstreams`` as follows:: With MSYS2, ``openocd`` and ``bscan-spi-bitstreams`` are included with ``artiq`` by default.
pacman -S mingw-w64-x86_64-openocd mingw-w64-x86_64-bscan-spi-bitstreams
With Conda, install ``openocd`` as follows:: With Conda, install ``openocd`` as follows::

2
doc/manual/list_of_ndsps.rst
View File

@ -29,4 +29,4 @@ The following network device support packages are available for ARTIQ. If you wo
| InfluxDB database | Not available | Not available | `HTML <https://gitlab.com/charlesbaynham/artiq_influx_generic>`_ | https://gitlab.com/charlesbaynham/artiq_influx_generic | | InfluxDB database | Not available | Not available | `HTML <https://gitlab.com/charlesbaynham/artiq_influx_generic>`_ | https://gitlab.com/charlesbaynham/artiq_influx_generic |
+---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------+ +---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------+
MSYS2 packages all start with the ``mingw-w64-x86_64-`` prefix. MSYS2 packages all start with the ``mingw-w64-clang-x86_64-`` prefix.