search

BenningtonCS / Telescope-2014

4 stars 0 forks source link

overhaul README file to be more descriptive and useful #2

Closed edaniszewski closed 10 years ago

edaniszewski commented 10 years ago

The README file currently lacks vast amounts of information on setting up and using the software. Once the software can be built stably and reliably, update the documentation to be a better resource.

edaniszewski commented 10 years ago

pushed what I had for this: added README notes from v1, v2, v3 into a Version History section. started to add a summary and documentation section, referencing the Haystack site and our wiki.

Could maybe still use more info, but I think since this isnt a pressing matter, I will just move it to a further milestone and worry about finishing it up later.

acencini commented 10 years ago

98 includes THIS

wbuchanan28 commented 10 years ago

should this be moved to dreamland, or is it more critical than that?

edaniszewski commented 10 years ago

No, I will work on the README tomorrow. I've made progress on it, but it still needs a little work

edaniszewski commented 10 years ago

With that referenced commit, the README should be good.

Since the bulk of the documentation has been happening in the wiki and documentation folder of the project, the README is not a novel