Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the documentation to reference new features #194

Closed
gkapfham opened this issue Sep 18, 2019 · 1 comment
Closed

Improve the documentation to reference new features #194

gkapfham opened this issue Sep 18, 2019 · 1 comment

Comments

@gkapfham
Copy link
Collaborator

There are several new features of GatorGrader that are not documented in the README file:

  • Use of Docker
  • Plugin-based approach
  • New sample repositories
  • Description of the check for markdown components
  • Description of the checks for different kind of counts
  • References to other auto-grading tools (see my new internal list)
  • Reference to article showing what happens when auto-graders crash (ask for reference)
  • Correct use of the ListChecks option in the documentation in the "Running" section

Until all of these issues are addressed, the documentation for GatorGrader will be out of sync with the actual implementation of the tool!

@corlettim
Copy link
Collaborator

@Ktaylor2, once we get everything fully set up on your laptop, we would like for you to start on this issue! If you have any questions, please let us know. We are always more than welcome to help.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants