locationtech / proj4j

Java port of the Proj.4 library for coordinate reprojection
Other
181 stars 71 forks source link

Extend README, add basic user guide #73

Closed sebkur closed 2 years ago

sebkur commented 2 years ago

Signed-off-by: Sebastian Kürten sebastian@topobyte.de

sebkur commented 2 years ago

See a rendered version of the changes here: https://github.com/sebkur/proj4j/tree/improve-docs

pomadchin commented 2 years ago

Hey @sebkur! Thanks for a cool PR. How do you feel about putting that quick user guide directly into the README.md?

sebkur commented 2 years ago

My primary intention was to add an example as it took me a few minutes to get some working code and would have liked to see some examples that let me dive right in.

In the process of doing that, I compared the current README.md to the one from JTS and figured there are a bunch of other things that should probably be there and added some of the obvious things:

sebkur commented 2 years ago

Hey @sebkur! Thanks for a cool PR. How do you feel about putting that quick user guide directly into the README.md?

yeah, seems like a good idea. Unless the main README gets too long, I think it would fit there quite well

pomadchin commented 2 years ago

@sebkur somewhere above the Building, Testing and installing locally section probably?

pomadchin commented 2 years ago

Thanks for doing that hard work! Everyone always forgets about docs, that's a big problem.

sebkur commented 2 years ago

Ok, pushed a new version

sebkur commented 2 years ago

thanks for the quick response!