vendor.lattice_{ecp5,machxo_2_3l}: explain how to set up NMIGEN_ENV_Diamond on Windows.

diff --git a/nmigen/vendor/lattice_ecp5.py b/nmigen/vendor/lattice_ecp5.py
index c798739f37068fd38b24d7f0e5687d0967ff43f4..3affa8f5616afbd313d9c0d789682e4a237e15ec 100644 (file)
--- a/nmigen/vendor/lattice_ecp5.py
+++ b/nmigen/vendor/lattice_ecp5.py
@@ -47,7 +47,12 @@ class LatticeECP5Platform(TemplatedPlatform):
         * ``ddtcmd``
 
     The environment is populated by running the script specified in the environment variable
-    ``NMIGEN_ENV_Diamond``, if present.
+    ``NMIGEN_ENV_Diamond``, if present. On Linux, diamond_env as provided by Diamond
+    itself is a good candidate. On Windows, the following script (named ``diamond_env.bat``,
+    for instance) is known to work::
+
+        @echo off
+        set PATH=C:\\lscc\\diamond\\%DIAMOND_VERSION%\\bin\\nt64;%PATH%
 
     Available overrides:
         * ``script_project``: inserts commands before ``prj_project save`` in Tcl script.

diff --git a/nmigen/vendor/lattice_machxo_2_3l.py b/nmigen/vendor/lattice_machxo_2_3l.py
index b215f62f9a5cc3df59199e13169e34164ff646c7..08c6008f44fe266310e62eec4b29a2be565190bf 100644 (file)
--- a/nmigen/vendor/lattice_machxo_2_3l.py
+++ b/nmigen/vendor/lattice_machxo_2_3l.py
@@ -16,7 +16,12 @@ class LatticeMachXO2Or3LPlatform(TemplatedPlatform):
         * ``ddtcmd``
 
     The environment is populated by running the script specified in the environment variable
-    ``NMIGEN_ENV_Diamond``, if present.
+    ``NMIGEN_ENV_Diamond``, if present. On Linux, diamond_env as provided by Diamond
+    itself is a good candidate. On Windows, the following script (named ``diamond_env.bat``,
+    for instance) is known to work::
+
+        @echo off
+        set PATH=C:\\lscc\\diamond\\%DIAMOND_VERSION%\\bin\\nt64;%PATH%
 
     Available overrides:
         * ``script_project``: inserts commands before ``prj_project save`` in Tcl script.