aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2019-12-31 22:30:29 -0500
committerJoseph Hunkeler <jhunkeler@gmail.com>2019-12-31 22:30:29 -0500
commit263bd26d281a530b78b56d298c29ffa368b0b981 (patch)
tree0c739765dc9f917ce8725aa9aeb84799967562e7 /README.md
parent5126cdc3c7385f01fe0839d63e2621914812dd26 (diff)
downloadspmc-263bd26d281a530b78b56d298c29ffa368b0b981.tar.gz
Update README.md
* Add environment.c
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 32 insertions, 1 deletions
diff --git a/README.md b/README.md
index 69d92ea..dd59c04 100644
--- a/README.md
+++ b/README.md
@@ -69,7 +69,7 @@ _TODO_
## Usage
```bash
-$ ./spm --help
+$ spm --help
usage: spm [-hVvBIrLS]
-h, --help show this help message
-V, --version show version
@@ -81,6 +81,37 @@ usage: spm [-hVvBIrLS]
-S, --search search for a package
```
+### Example
+
+#### Install Python
+```bash
+$ spm --root ~/spmenv123 --install "python" # [...]
+```
+
+#### Export environment variables
+
+```bash
+$ export PATH="~/spmenv123/bin:$PATH"
+$ export MANPATH="~/spmenv123/share/man:$MANPATH"
+$ hash -r # or "rehash" if your shell supports it
+```
+
+#### Use Python
+
+```bash
+$ which python
+/home/example/spmenv123/bin/python
+$ which pip
+/home/example/spmenv123/bin/pip
+$ which git
+/home/example/spmenv123/bin/git
+
+$ python -m venv ~/spmenv123/venv
+$ source ~/spmenv123/venv/bin/activate
+$ pip install https://github.com/spacetelescope/jwst.git#egg=jwst
+# ... do work
+```
+
## Building SPM Packages
_TODO_