aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSalvador Fuentes Jr <[email protected]>2011-08-30 02:32:55 -0700
committerSalvador Fuentes Jr <[email protected]>2011-08-30 02:32:55 -0700
commit7f8902bf542cb345e22cc6b89fe15f3d16fb4e5c (patch)
tree4cad7e4a878e28769ef65369e5bd5fc548653baf /README.md
parent2f07012fa36580ec8b1b4bafcbfce4056c20e47d (diff)
downloadkerl-7f8902bf542cb345e22cc6b89fe15f3d16fb4e5c.tar.gz
kerl-7f8902bf542cb345e22cc6b89fe15f3d16fb4e5c.tar.bz2
kerl-7f8902bf542cb345e22cc6b89fe15f3d16fb4e5c.zip
update documentation on readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index 57e2212..0193647 100644
--- a/README.md
+++ b/README.md
@@ -175,7 +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_DEFAULT_INSTALL_DIR if set in ~/.kerlrc, install builds to this dir if no path is provided on installs, (recommend "$KERL_BASE_DIR/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
@@ -239,7 +239,7 @@ Install a named build to the specified filesystem location
kerl install <build_name> [path]
-If path is ommited KERL_DEFAULT_INSTALL_DIR/<build-name> will be used
+If path is ommited the current working directory will be used. However, if KERL_DEFAULT_INSTALL_DIR is defined in ~/.kerlrc, KERL_DEFAULT_INSTALL_DIR/<build-name> will be used instead.
*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!