python-isal

python-isal copied to clipboard

I got hints from other PRs, but the need for submodules is not documented. This is with today's git develop.

From the installation manual.

The latest development version of python-isal can be installed with:

pip install git+https://github.com/rhpvorderman/python-isal.git

This automatically installs the submodules.

Can you specify what is lacking about not explicitly stating that there are submodules? It is not needed if the listed installation instructions are used.

I cloned the repo, because it was clear I was going to have to fix something, and ran setup.py. I also, I think, tried to run pip passing the directory. I definitely ended up with a "can't find Makefile.unx" error which was quite mysterious.

I think instructions should help people building modified versions from local repos, not just building from unmodified github.

I don't understand your reluctance to just straightforwardly state the requirements. Having that missing seems like an unnecessary barrier to use and contributions.

I look at a readme to be for people using the source. It seems entirely fine to put installation instructions in INSTALL.md and have only a line or two in readme to say "see INSTALL.md for installation".

I think instructions should help people building modified versions from local repos, not just building from unmodified github.

Clear, I could add a small development chapter in the documentation which would state to use "git clone --recursive" etc and also provide a link to the ISA-L list of build requirements. I could link that from the README.

I don't understand your reluctance to just straightforwardly state the requirements.

That's not an entirely accurate rendition of my position. I do not want to clutter the landing page with very detailed information that is irrelevant to most users. Having said that, your suggestion to provide detailed instructions linked from the README also works for me. I will put this on the to-do list.

Great, thanks. I do understand the githubby landing page notion, even though I come from an earlier time :-)

A recursive clone is now recommended on the README.