README fix
[wsl-litex-quartus.git] / README.md
1 A patch to integrate Quartus Prime installed on Windows into WSL LiteX workflow.
2
3 Tested on WSL2.
4
5 ### Installation
6
7 If you are in the same directory as the patch file:
8
9 ```
10 cd <path-to-your-litex-install>
11 patch -p1 < "$OLDPWD"/wsl-litex-quartus.diff
12 ```
13
14 If LiteX was installed with Python venv, `<path-to-your-litex-install>` is `<directory-with-litex_setup.py>/litex`.
15 Before installling, you might want to change the fallback for `$LITEX_WIN32_QUARTUS_PATH` in the patch file so you
16 don't have to set it on each new session (or just export the variable in venv activation script).
17
18 ### Environment Variables
19
20 * `$WSL_DISTRO_NAME` - is used to set the path to files for Quartus, ensure it is correct (should be set automatically)
21
22 * `$LITEX_WIN32_QUARTUS_PATH` - is the path to Quartus `bin64` from within WSL, eg., `/mnt/c/altera_lite/25.1std/quartus/bin64`
23
24 ### Flags
25
26 * `--win32-quartus` - use the Windows Quartus install
27
28 * `--win32-quartus-path WIN32_QUARTUS_PATH` - path to Quartus, overrides `$LITEX_WIN32_QUARTUS_PATH`