From e978430c54dc1ec400d89ee2b26f53fcb6921075 Mon Sep 17 00:00:00 2001 From: Sebastien Bourdeauducq Date: Fri, 17 Aug 2018 12:27:17 +0800 Subject: [PATCH] nix: add warnings to README --- nix/README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/nix/README.rst b/nix/README.rst index ce0e0931c..7df289bd4 100644 --- a/nix/README.rst +++ b/nix/README.rst @@ -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.