Voting-Rights-Code / Equitable-Polling-Locations

Optimization tool for selecting the most equiatable set of polling locations (by Kolm-Pollack distance)
GNU General Public License v3.0
9 stars 3 forks source link

initial commit of updated basic README #63

Open jmlar opened 2 weeks ago

jmlar commented 2 weeks ago

Susama -

this was a very quick attempt to move your last project forward. I hate leaving low hanging fruit especially when this only took an hour or two:

  1. created separate README files by splitting up your old file at each of you old major headings
  2. drafted new main page based on Daniel's suggestions. I added appropriate badges and a logo so it would look more like an open source project. Hopefully the text is something close to what Daniel was thinking of.
  3. moved all markdown files into a document directory
  4. moved logo and old images into assets directory
  5. did a rough proof read of all pages. Standard headers, converted equations into math, removed internal comments, typos, etc.
  6. note that at the bottom of README i posted a link to your discord. Didn't know if you wanted this, or what page to point it to so remove/edit it.
  7. technically I configure the files to work with GitHub Wiki but you would need to pay extra for this feature so I left the files as hyperlinks

There are other changes I would have made to the markdown text but I left it pretty much as it was in the original long README