From 485520dc3e5533d948ee72d73d0c70475c92dfaa Mon Sep 17 00:00:00 2001 From: Joseph Hunkeler Date: Sat, 8 Oct 2016 23:37:01 -0400 Subject: Add examples --- README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) 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. -- cgit