Skip to content

Commit

Permalink
update documentation on readme
Browse files Browse the repository at this point in the history
  • Loading branch information
scalone-cw committed May 9, 2024
1 parent a49a9b6 commit f04b9d7
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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!

Expand Down

0 comments on commit f04b9d7

Please sign in to comment.