Oslandia / py3dtiles

:warning: Project migrated to : https://gitlab.com/py3dtiles/py3dtiles :warning:
https://py3dtiles.org
Other
213 stars 77 forks source link

Split README into multiple files #32

Closed elemoine closed 5 years ago

elemoine commented 5 years ago

This PR suggests to restructure the documentation a bit. The README now just includes a short description of py3dtiles, and then provides links to separate RST files covering the installation, the CLI usage and the API usage.

I've just changed the structure, not the content. In the future we may want to add screenshots and/or performance tables to the README.

elemoine commented 5 years ago

You can open https://github.com/Oslandia/py3dtiles/blob/readme/README.rst to see what the new README looks like.

peppsac commented 5 years ago

Maybe the Third party assets section could be moved to the LICENSE file?

elemoine commented 5 years ago

Maybe the Third party assets section could be moved to the LICENSE file?

Good call. I added a commit for that.

elemoine commented 5 years ago

Thanks for the review.