Update running authored by Fahmi Salleh's avatar Fahmi Salleh
......@@ -29,10 +29,7 @@ $ venvtools help
Press [tab] twice for commands and environments auto completion.
```
## Commands Action
### Create Virtual Environment
## Create Virtual Environment
Command *create* will create environment and project directory. Its also will run *venv* to generate files required by environment. Its required two arguments:
......@@ -52,7 +49,7 @@ venvtools: virtual environments deployed [myotcenv]
```
##### Parameter Environment and Project Directory Is Not Set
#### Parameter Environment and Project Directory Is Not Set
* Current directory (*$PWD*) is */home/user1*.
* Parameter *VENVTOOLS_ENVIRONMENT* is not set.
......@@ -89,7 +86,7 @@ VENVTOOLS_PROJECT=
| `PROJ_DIR` | myenv5 | /home/user1/myenv5 |
##### Parameter Environment and Project Directory Is Set
#### Parameter Environment and Project Directory Is Set
* Current directory (*$PWD*) is */home/user1*.
* Parameter *VENVTOOLS_ENVIRONMENT* set to */workspace/environments*.
......@@ -125,7 +122,7 @@ VENVTOOLS_PROJECT="/workspace/projects"
| `ENV_DIR` | myenv7 | /workspace/environments/myenv7 |
| `PROJECT_DIR` | myenv7 | /workspace/projects/myenv7 |
### List Virtual Environment
## List Virtual Environment
Following *list* Command will list all virtual environment created using venvtools.
......@@ -141,7 +138,7 @@ myenv4 /Users/devboy/Workspaces/Environments/myenv4 /Users/
myenv5 /Users/devboy/Workspaces/Environments/myenv5 /Users/devboy/Workspaces/Developments/proj5
myotcenv /Users/devboy/Workspaces/Environments/myotcenv /Users/devboy/Workspaces/Developments/myotcproj
```
### Remove Virtual Environment
## Remove Virtual Environment
Use *remove* command to remove or delete virtual environment. This action will delete all associated environment plus project directories and all its contents. Command required only one argument which is environment name.
......@@ -157,7 +154,7 @@ Please confirm to remove environment and its project? [myenv4] [Yy/Nn] y
venvtools: virtual environments removed [myenv4]
```
### Activate Virtual Environment
## Activate Virtual Environment
Following *activate* command will activate selected virtual environment and automatically change to project directory. Action required only one argument which is environment name.
......@@ -172,7 +169,7 @@ devbox:~ devboy$ venvtools activate myotcenv
(myotcenv) devbox:myotcproj devboy$
```
### Deactivate Virtual Environment
## Deactivate Virtual Environment
Command *deactivate* will deactivate current active virtual environment and cd to $HOME
......@@ -192,7 +189,7 @@ devbox:~ devboy$
devbox:myotcproj devboy$
```
### Help Display
## Help Display
Use *help* command to display venvtools help page:
......@@ -229,7 +226,7 @@ devbox:~ devboy$ venvtools help
Press [tab] twice for commands and environments auto completion.
```
### Version Display
## Version Display
Following *version* action will display venvtools version and license information:
......
......