diff options
| author | Radek Szymczyszyn <[email protected]> | 2017-11-04 23:36:56 +0100 |
|---|---|---|
| committer | Radek Szymczyszyn <[email protected]> | 2017-11-04 23:36:56 +0100 |
| commit | 578b6200e35a19b0d7473a267f7b0b1d557e724f (patch) | |
| tree | ba43245afc4bcc04a3d3f4747009cefa44826715 | |
| parent | 2f2a4907dee9ee0f3a87f089bbf9a7bfdc1c98cb (diff) | |
| download | kerl-578b6200e35a19b0d7473a267f7b0b1d557e724f.tar.gz kerl-578b6200e35a19b0d7473a267f7b0b1d557e724f.tar.bz2 kerl-578b6200e35a19b0d7473a267f7b0b1d557e724f.zip | |
Extend install-docsh command description
| -rw-r--r-- | README.md | 8 |
1 files changed, 8 insertions, 0 deletions
@@ -624,6 +624,11 @@ This extends the shell with new helpers, which enable access to full function help (via `h/{1,2,3}`), function specs (`s/{1,2,3}`) and type information (`t/{1,2,3}`). +If you already have an OTP installation, you will need to remove it and +re-install it **before** you execute `install-docsh`, +since docsh needs some environment variables of its own to be set up +and managed by the activate script. + Activating a docsh-enabled Erlang installation will try to create a `$HOME/.erlang` symlink. If this file exists (i.e. you have created it manually), @@ -634,8 +639,11 @@ Alternatively, if the file exists and you have to keep it you can extend it with the content of [a docsh-specific `.erlang`][docsh-dot-erlang] - this task is left as an exercise for the reader - and export `KERL_DOCSH_DOT_ERLANG=exists` to silence unwanted warnings. +The [manual setup guide][docsh-manual-setup] will probably come in handy +if you decide to take this route. [docsh-dot-erlang]: https://github.com/erszcz/docsh/blob/2d9843bce794e726f591bbca49c88aedbb435f8c/templates/dot.erlang +[docsh-manual-setup]: https://github.com/erszcz/docsh/blob/ecf35821610977e36b04c0c256990a5b0dab4870/doc/manual-setup.md Compiling crypto on Macs ------------------------ |