Skip to content
Browse files

adding docs on new commands

  • Loading branch information...
1 parent f38c31c commit 3636b449a60cfc57988f8ba3c8a129e708d02d80 @aconbere committed
Showing with 46 additions and 7 deletions.
  1. +44 −5 README.md
  2. +2 −2 rockspecs/vert-0.0.3-1.rockspec
View
49 README.md
@@ -3,13 +3,13 @@
Produces a localized install of lua and luarocks for isolated installation and
running of lua programs.
-## Command [vert]
+## Creating an environment
-To run vert just run `vert` with the path to the directory to install into
+To run vert just run `vert init` with the path to the directory to install into
- $> vert .
- $> source ./bin/activate
- (vert) $> lua
+ $> vert init .
+ $> source ./bin/activate (vert)
+ $> lua
Lua 5.1.5 Copyright (C) 1994-2012 Lua.org, PUC-Rio
You can configure which lua and luarocks version to use with with the config
@@ -37,6 +37,45 @@ Once an environment is activate simple run `deactivate` to exit
(vert)$> deactivate
+Alternatively in your bashrc or zshrc you can source the `vert_wrappers.sh`
+installed, it will provide a function `verton` that will activate verts found
+in `~/.verts`
+
+## Commands
+
+## Subcommands
+
+### vert init
+
+`vert init` will build a vert in a given directory
+
+ $> vert init /my/env
+
+### vert make
+
+`vert make` will build a new vert in your ~/.verts directory
+
+ $> vert make my_env
+
+### verton
+
+`verton` is a shell function available if you source
+`/usr/bin/env/vert_wrapper.sh` it will activate a vert found in ~/.verts
+
+ $> verton my_env
+
+### vert rm
+
+`vert rm` will remove a vert in ~/.verts
+
+ $> vert rm my_env
+
+### vert ls
+
+`vert ls` will list all your verts in ~/.verts
+
+ $> vert ls my_env
+
## Platform Support
Currently I've only tested this on linux, though given lua's support for many
View
4 rockspecs/vert-0.0.3-1.rockspec
@@ -2,8 +2,8 @@ package = "Vert"
version = "0.0.3-1"
-source = { url = "git://github.com/aconbere/vert.git"
- , tag = "v0.0.3-rc1"
+source = { url = "git://github.com/aconbere/vert.git"
+ , tag = "v0.0.3"
}
description = { summary = "Creates isolated development environment"

0 comments on commit 3636b44

Please sign in to comment.
Something went wrong with that request. Please try again.