search

UMBC-CMSC447-Spring2017-Team5 / college-JUMP

https://lassa.xen.prgmr.com/collegejump/
GNU General Public License v3.0
0 stars 0 forks source link

Update the repository README #25

Open alexander-bauer opened 7 years ago

alexander-bauer commented 7 years ago

I can provide some direction here, but won't be able to get to actually doing it for a long time. @UMBC-CMSC447-Spring2017-Team5/developers, can someone who feels under-tasked take over?

RyanErnst commented 7 years ago

@alexander-bauer in what way should I modify the README? I assume you want the "Developer's Guide" sections untouched and want some updated background info in the section "information and background." But, were you also looking into adding a "set-up" or "installation" guide?

alexander-bauer commented 7 years ago

@RyanErnst Right now, the README could use some more information on how the system is packaged, and how to run it with and without the makefile. It could also stand to point at the Jenkins instance, for the packaging artifacts, or maybe the GitHub release tags. (Those might be better, actually.)

It should also have some background information, and information about why we're writing the project, and all that. I don't have any specific targets besides those, but it just feels a bit bare at the moment.

alexander-bauer commented 7 years ago

@RyanErnst Also, I just noticed that there's a random code snippet that got in there somehow; if you're editing it already, you can pull that out, too.