M-Labs
/
artiq
mirror of https://github.com/m-labs/artiq.git
2
0
Fork 2
Code Issues Projects Releases Wiki Activity

nix: add warnings to README

This commit is contained in:
Sebastien Bourdeauducq 2018-08-17 12:27:17 +08:00
parent 233c841f2e
commit e978430c54
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
nix/README.rst
View File

@ -3,7 +3,7 @@ Install ARTIQ via the Nix Package Manager
These instructions provide an alternative route to install ARTIQ for people who do not wish to use conda.
This sets up an environment suitable for using ARTIQ, including the ARTIQ-Python compiler, device drivers, and the graphical user interfaces. This works correctly on Linux, and partially works with WSL introduced in Windows 10.
This sets up an environment suitable for using ARTIQ, including the ARTIQ-Python compiler, device drivers, and the graphical user interfaces. This works correctly on Linux, and partially works (but not to a level that we would consider usable) with WSL introduced in Windows 10.
ARTIQ firmware and gateware development tools (e.g. rustc, Migen) and ARTIQ core device flashing tools (OpenOCD, proxy bitstreams) are currently not available on Nix. Pull requests welcome!
@ -25,4 +25,4 @@ ARTIQ firmware and gateware development tools (e.g. rustc, Migen) and ARTIQ core
* $ ``cd artiq/nix``
* $ ``nix-env -i -f default.nix``
The above command will setup your entire environment.
The above command will setup your entire environment. Note that it will compile LLVM and Clang, which uses a lot of CPU time and disk space.