Documentation Improvements

NREL / routee-compass

An energy-aware routing engine

https://nrel.github.io/routee-compass/

BSD 3-Clause "New" or "Revised" License

10 stars 5 forks source link

Open nreinicke opened 4 months ago

nreinicke commented 4 months ago

Opening this as a catch-all for some documentation updates based on feedback from newcomers installing and using the package.

[x] On the contributing page, after install, it would be good to point to an example that can be easily run to check to see if everything is working properly. Maybe this is the open street maps example or maybe another simpler script that doesn't require jupyter to run.

nreinicke commented 4 months ago

[x] Add a link to the contributions page from the Readme in the Contributors section.