search

enzet / map-machine

Python renderer for OpenStreetMap with custom icons intended to display as many map features as possible
MIT License
510 stars 33 forks source link

Finish installation instructions #115

Closed ghost closed 2 years ago

ghost commented 2 years ago

Currently, the install section of the readme is practically empty. This should ideally be filled.

enzet commented 2 years ago

Hi @berrely! Thank you for reporting!

Could you please explain what exactly do you want to see in the Install section? I just wanted to left it as short as possible to make things simple.

ghost commented 2 years ago

Hi @berrely! Thank you for reporting!

Could you please explain what exactly do you want to see in the Install section? I just wanted to left it as short as possible to make things simple.

Well ideally they'd have all the Python packages you need (listed in the packages file) and instructions on how to download and install on different operating systems, but even basic installation steps would be useful.

enzet commented 2 years ago

pip install . will do just everything needed for the Python part: it will install required packages and make map-machine available from the command line. Two listed libraries have pretty nice installation steps on their sites for all operating systems. So I believe strictly speaking the Installation section is fine and I really don't want to enlarge it.

Maybe it's good idea to create additional INSTALL.md file with ultimate list of steps for each operating system starting from installation of Python and pip? And add a link to it from the readme?

ghost commented 2 years ago

That would be very useful. Something like "For installation instructions, see INSTRUCTIONS.md"

enzet commented 2 years ago

Thank you! I'll try to write this at least for Ubuntu and macOS.

enzet commented 2 years ago

Hello @berrely! Could you please take a look at pull request #116, does it make things more clear?

sikmir commented 2 years ago

Just in case, there is a package for NixOS.

enzet commented 2 years ago

Just in case, there is a package for NixOS.

Wow, this is great! Thank you!

May I refer to it from the INSTALL.md file?

sikmir commented 2 years ago

May I refer to it from the INSTALL.md file?

Yes, but it's NUR repository, it's not submitted to nixpkgs, since map-machine is not released yet.

ghost commented 2 years ago

Hello @berrely! Could you please take a look at pull request #116, does it make things more clear?

Yep, looks great. It would be nice if there were instructions how to run it as well, but this is great regardless. Thanks!

enzet commented 2 years ago

Right.

since map-machine is not released yet.

Shame on me. I should have done this long ago.

enzet commented 2 years ago

Great!

It would be nice if there were instructions how to run it as well, but this is great regardless.

Yes, I'll gradually expand usage section in the future.

Thank you!