aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSalvador Fuentes Jr <[email protected]>2011-08-25 21:19:08 -0700
committerSalvador Fuentes Jr <[email protected]>2011-08-25 21:19:08 -0700
commit780e84404b0478495cba6912a2b2434e11d95f58 (patch)
tree29ac5898d8201ab09f37b86fa4d7446fc9c1b918 /README.md
parentc382bc744dd93a5aa7df1ee47113233f52b78bab (diff)
downloadkerl-780e84404b0478495cba6912a2b2434e11d95f58.tar.gz
kerl-780e84404b0478495cba6912a2b2434e11d95f58.tar.bz2
kerl-780e84404b0478495cba6912a2b2434e11d95f58.zip
update kerl install documentation on README
Diffstat (limited to 'README.md')
-rw-r--r--README.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/README.md b/README.md
index eb69397..57e2212 100644
--- a/README.md
+++ b/README.md
@@ -175,6 +175,7 @@ You can set the following variables:
- KERL_DOWNLOAD_DIR where to put downloaded files, defaults to $HOME/.kerl/archives
- KERL_BUILD_DIR where to hold the builds, defaults to $HOME/.kerl/builds
+- KERL_DEFAULT_INSTALL_DIR where to install builds to if no path is provided, defaults to $HOME/.kerl/installs
- KERL_CONFIGURE_OPTIONS options to pass to Erlang's ./configure script, e.g. --without-termcap
- KERL_DISABLE_AGNER if non-empty will disable agner support
- KERL_AGNER_AUTOINSTALL a list of packages to pre-install
@@ -238,7 +239,7 @@ Install a named build to the specified filesystem location
kerl install <build_name> [path]
-If path is ommited the current working directory will be used
+If path is ommited KERL_DEFAULT_INSTALL_DIR/<build-name> will be used
*Note*: kerl assumes the specified directory is for its sole use. If you later delete it with the kerl delete command, the whole directory will be deleted, along with anything you may have added to it!