try to make documentation easier to follow

[matkoniecz]

Attempt to make documentation easier to follow.

Disclaimer: I am not 100% is it a good advice but once I did it things started to work.

At least for me it was not obvious what should be put there, especially as

Downloading and adding libosmium sources from https://github.com/osmcode/libosmium/archive/v2.20.0.tar.gz
Downloading and adding protozero sources from https://github.com/mapbox/protozero/archive/v1.7.1.tar.gz
Downloading and adding pybind11 sources from https://github.com/pybind/pybind11/archive/v2.11.1.tar.gz

was seen in logs, shortly before erroring out (but for some reason this manual cloning repositories was still needed).

Done as part of #230 in hope that such PR (like some my recent PRs in related repos) are more useful than annoying.

[matkoniecz]

To be more specific:

mateusz@grima:~/Documents/install/pyosmium/dist$ python3.8 -m pip install --user *.whl

worked fine and I have now working example code (yay)

while

mateusz@grima:~/Documents/install/pyosmium/dist$ python3.10 -m pip install --user *.whl
ERROR: osmium-3.7.0-cp38-cp38-linux_x86_64.whl is not a supported wheel on this platform.

failed with unclear error (see pypa/pip#10793 ) - so maybe that advise above is actually wrong and I should have done something else?

[lonvia]

That's a good addition. Do you also want to add the commands to execute for the cloning to copy&paste for the next person? They should remain fairly stable.

[matkoniecz]

I had another thought (though implementing this is likely beyond my abilities right now, I know nothing about cmake) - but is there reason why build process cannot do this? Why it needs to be done manually?

Or is it simply case of "nice to have, will not code itself on its own"

[matkoniecz]

Do you also want to add the commands to execute for the cloning to copy&paste for the next person? They should remain fairly stable.

Done (though from memory, not tested them)

[lonvia]

The build process does it by itself. It downloads the released version of the libraries as per src/osmium/version.py and properly puts everything into the source package. It's only when you run in development mode (i.e. build locally) that you need the links.