Skip to content

Commit

Permalink
adding docs on new commands
Browse files Browse the repository at this point in the history
  • Loading branch information
aconbere committed Jun 1, 2012
1 parent f38c31c commit 3636b44
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 7 deletions.
49 changes: 44 additions & 5 deletions README.md
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions rockspecs/vert-0.0.3-1.rockspec
Expand Up @@ -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"
Expand Down

0 comments on commit 3636b44

Please sign in to comment.