search

OpenGeoscience / uvdat

UVDAT Urban Visualization and Data Analysis Toolkit
Apache License 2.0
1 stars 1 forks source link

Create a docs folder and improve README #37

Closed annehaley closed 3 months ago

annehaley commented 9 months ago

This PR improves the README by separating the setup and testing instructions and adding more language from the project abstract. The README is now in the docs folder, but Github will still display it on the front page of the repository. I have also added some images and a mkdocs.yml so we can publish this to ReadTheDocs.

Preview: https://github.com/OpenGeoscience/uvdat/tree/update-readme

johnkit commented 8 months ago

I have some suggested editorial changes. Reorganized a bit and added a few more details. I'll attach pdf with preview as well as patch file for consideration.

0001-Editorial-changes.patch.txt (Remove the .txt extension -- I had to add it in order to get github to accept the upload)

UVDAT-Documentation.pdf (For some reason, my "material" style doesn't match github's.)

johnkit commented 8 months ago

Note that if you use my changes, please fix the typo "representatitons" ==> "representations"

johnkit commented 3 months ago

It appears that you added uvdat_flow.jpg but we don't use it (commented out). Was that on purpose or just an earlier version? My preference would be to leave the image out and remove the comment (line 12 in README.md).

annehaley commented 3 months ago

@johnkit I added the uvdat flow diagram in 4222b7b, and part of your suggested changes comments out the image reference. I removed the image and the comment in 3dbeb10.

johnkit commented 3 months ago

@johnkit I added the uvdat flow diagram in 4222b7b, and part of your suggested changes comments out the image reference. I removed the image and the comment in 3dbeb10.

Roger all that, thanks. Glad your memory is better than mine :)

The jpg will still be in the repository, but at 16KB that's fine. I'll OK for merging.