aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2016-10-08 23:37:01 -0400
committerJoseph Hunkeler <jhunkeler@gmail.com>2016-10-08 23:37:01 -0400
commit485520dc3e5533d948ee72d73d0c70475c92dfaa (patch)
tree60e70c7c9d3ff3a9339f79b5b56abd2212b47f61
parent932971bdd66b628fa1bc34e68f1e468c14525b97 (diff)
downloadssb-utils-485520dc3e5533d948ee72d73d0c70475c92dfaa.tar.gz
Add examples
-rw-r--r--README.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2a30469..70d64ff 100644
--- a/README.md
+++ b/README.md
@@ -39,11 +39,55 @@ General Arguments:
Mode Arguments:
--install -i Perform an installation
--update -u Perform an update
+ --create -c Create an environment
Positional Arguments:
package Name of package(s) to update
```
+### Examples
+
+(There are many permutations of this command, but the samples below should be sufficient to get you started)
+
+Creating a dev environment
+
+```bash
+ssb --create --dev --name mydev27 python=2.7 stsci
+ssb --create --dev --name mydev35 python=3.5 stsci
+```
+
+Creating an AstroConda environment
+
+```bash
+ssb --create --public --name mypublic27 python=2.7 stsci
+ssb --create --public --name mypublic35 python=3.5 stsci
+```
+
+Updating a dev environment by name
+
+```bash
+ssb --update --all --dev --name mydev
+```
+
+Updating an active dev environment
+
+```bash
+source activate mydev
+ssb --update --all --dev
+```
+
+Installing a package into a dev environment
+
+```bash
+ssb --install --dev --name mydev [pkg_name]
+```
+
+Installing a package into an active dev environment
+
+```bash
+ssb --install --dev [pkg_name]
+```
+
# Support
Use at your own risk.