Readme #37
Readme #37
Conversation
hayleepierce
requested review from
gkapfham,
AidanNeeson,
jnormile,
rodriguez03 and
hayleepierce
hayleepierce
added
documentation
EvanNelson04
added
ready-for-review
|
|
||
| ## ⚡️ Requirements | ||
|
|
||
| - Cellveyor git hub repository |
There was a problem hiding this comment.
This is a little nit-picky, but given that we're aiming to produce software that presents as professional-quality, it's worth noting that it should be GitHub (proper noun, one word).
README.md
Outdated
| ## 🎉 Introduction | ||
|
|
||
| - Cellveyor is a python program that produces assignment reports for students or | ||
| classes. Using cellveyor will publicly give grade reports including feedback for |
There was a problem hiding this comment.
We should be consistent with the casing for Cellveyor (either always all lowercase, or always have the "C" capitalized).
There was a problem hiding this comment.
okay, I reviewed that and fixed all of it
README.md
Outdated
| created, this will quickly and automatically send out these reports in a very timely | ||
| and efficient fashion. | ||
|
|
||
| ## 😂 Definitions |
There was a problem hiding this comment.
While I see what you're going for based on the chasten repository, I'm not sure a "Definitions" section is really warranted. "Cellveyor" isn't necessarily a real word (like chasten); instead, if you're interested in a section like this, re-tool it to give some explanation behind the tool's name.
There was a problem hiding this comment.
I changed the definition of cellveyor a bit, could I use the sentence usage part?
Readme update looking for review