summaryrefslogtreecommitdiffstats
path: root/README.txt
diff options
context:
space:
mode:
authorJoel Sherrill <joel@rtems.org>2023-07-18 15:28:20 -0500
committerJoel Sherrill <joel@rtems.org>2023-08-09 10:40:56 -0500
commit7bd117cb00b68e5cb89aa8c237a813730876817e (patch)
treeacb0bab9398635e363f712afe39d06b09b77f4fb /README.txt
parenteng: add Apache License 2.0 restriction (diff)
downloadrtems-docs-7bd117cb00b68e5cb89aa8c237a813730876817e.tar.bz2
Add Regulator documentation based on V1 functionality
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt19
1 files changed, 17 insertions, 2 deletions
diff --git a/README.txt b/README.txt
index b61a73a..1c4d729 100644
--- a/README.txt
+++ b/README.txt
@@ -120,8 +120,10 @@ Please add your host to this section as you set it up.
The best results are produced with Python3 and a virtual environment`. It can
create a specific python environment using `pip`.
-Virtual Environment
-~~~~~~~~~~~~~~~~~~~
+Similarly, npm packages can be installed into a users $HOME directory.
+
+Python Virtual Environment
+~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a directory to house the virtual environment, create the environment,
and then activate it. This example assumes Python3 and the `venv` module:
@@ -143,6 +145,19 @@ Either way, the prompt will now change. You can install Sphinx with:
When you have finished you enter `deactivate`.
+NPM Per User Environment
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Change npm's default directory to a local one:
+
+ mkdir ~/.npm-global
+ npm config set prefix '~/.npm-global'
+
+Subsequent packages installed via `npm install` will be local
+to the user. The following shows the PATH changes needed.
+
+ export PATH=${HOME}/.npm-global/bin:$PATH
+
Sphinx Per User Install
~~~~~~~~~~~~~~~~~~~~~~~