summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorMats Wichmann <mats@linux.com>2022-07-25 12:10:20 -0600
committerMats Wichmann <mats@linux.com>2022-07-25 12:12:05 -0600
commit520572726995a8563f61d4216925697ea5bbbdc5 (patch)
tree346b3936e3fe941206242cec814708dda8de42c6 /CONTRIBUTING.rst
parent9b7ff87c5382f717bea52c501dc992f67c6f869e (diff)
downloadscons-git-520572726995a8563f61d4216925697ea5bbbdc5.tar.gz
Put back add-scons-to-PATH option [ci skip]
Signed-off-by: Mats Wichmann <mats@linux.com>
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 150e594c8..d4df14a92 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -146,6 +146,23 @@ Now while this virtualenv is activated, the command ``scons`` will refer
to this editable version, and you don't have to be "in" this tree
to run it.
+You can also arrange to execute ``scons.py`` from the command line
+by adding it to the ``PATH``, like::
+
+ # on Linux/Mac
+ $ export PATH=$PATH:`pwd`/scripts
+
+ # on Windows
+ C:\> set PATH="%PATH%;C:\path\to\scripts"
+
+Be careful on Windows, the path has a limit of 1024 characters which
+is pretty easy to exceed, and it will just truncate.
+
+You may first need to make ``scons.py`` executable (it should be
+by default, but sometimes things happen)::
+
+ $ chmod +x scripts/scons.py
+
Other Required Software
=======================