ccavanaugh / jgnash

jGnash Personal Finance
http://ccavanaugh.github.io/jgnash/
Other
139 stars 80 forks source link

Readme: reorganized sections. More explicit info about Java 9+ usage #62

Closed weedySeaDragon closed 5 years ago

weedySeaDragon commented 5 years ago

My take on what would make the README better: including standard sections about Requirements and Installation, etc., and reorganization of information into the more standard sections and order

I didn't delete any information, but I did edit/wordsmith a bit. I added more information about using Java versions 9 or later to try to reduce confusion and error when running with those versions.

I also added a Contents section up top (bullet list). Perhaps it should be collapsed some.

This does need some proofreading. I didn't do a complete proofreading because I wanted to get feedback on the reorganization first. Once that's settled, then a careful proofreading can be done.

ccavanaugh commented 5 years ago

It looks really nice! I read through and did not find anything glaring, but did not do a full proof.

Let me know when you are ready, and I will be happy to commit.

Thanks, Craig

weedySeaDragon commented 5 years ago

Sorry for the delay. Go ahead and commit this when you're ready.

ccavanaugh commented 5 years ago

Thanks!!