search

matkoniecz / lunar_assembler

SVG maps from OpenStreetMap data. Available at https://mapsaregreat.com/osm_to_svg_in_browser/
GNU Affero General Public License v3.0
40 stars 5 forks source link

review documentation - I welcome complaints, nitpicking, comments, praise and other feedback about documentation in comments here! #104

Open matkoniecz opened 3 years ago

matkoniecz commented 3 years ago

https://producingoss.com/en/producingoss.html#documentation is a fairly good set of recommendation

matkoniecz commented 3 years ago

@peternewman In unlikely case that you would be both interested and had time for that - review of English would be highly appreciated!

peternewman commented 3 years ago

What are you talking about, just the Markdown files in the root? No promises, but it should be on my mentioned issues list now...

Actually you might need to ping me again after this reply so it shows as un-actioned!

matkoniecz commented 3 years ago

@peternewman Especially https://github.com/matkoniecz/lunar_assembler/blob/master/README.md

But also review of https://mapsaregreat.com/osm_to_svg_in_browser/ and pages linked there would be welcomed.

Content of that pages is defined in html files in https://github.com/matkoniecz/lunar_assembler/tree/master/examples and legends are automatically generated by this tool.