asdf-erlang icon indicating copy to clipboard operation
asdf-erlang copied to clipboard

README: Move info about building docs above platform-specific dependency info?

Open rayrrr opened this issue 3 years ago • 1 comments

Hi, can we move the info in the README under the heading "Getting Erlang documentation" above the info about specific platform dependency installation, so that it is the first thing under the "Before asdf install" heading?

Given that it is embedded documentation, those steps must be performed before compilation (and should be encouraged) but I think one might assume that the platform-specific steps are the last thing to do and not scroll down to see it the embedded documentation info where it currently is.

Then the section that reads:

  1. KERL_BUILD_DOCS environment variable has to be set to value yes
  2. Additional dependencies have to be installed. For detailed list of dependencies for your OS please refer to the specific section above

could instead say "please refer to the specific section below."

Happy to furnish a PR if so. Thanks!

rayrrr avatar May 29 '21 16:05 rayrrr

Hi @rayrrr , sorry for the late reply here! Hmm... I could see benefits to both orders. If we opted to move the section on Getting Erlang documentation up, we'd end up with the OS-specific dependency installation instructions at the very bottom of the readme, which seems a little backwards to me.

Stratus3D avatar Jul 23 '21 19:07 Stratus3D