Skip to content

Commit

Permalink
docs: Give a better example of the example command in the README.md
Browse files Browse the repository at this point in the history
file.
  • Loading branch information
gkapfham committed Oct 31, 2023
1 parent 7c03f58 commit 6073b89
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,17 @@
## Example Command

```
poetry run cellveyor --spreadsheet-directory /home/gkapfham/working/data/gradebook/2023 --spreadsheet-file CMPSC-203-Fall-2023-Gradebook.xlsx --sheet-name Main --key-attribute "Student GitHub" --key-value "gkapfham" --column-regexp "^(Summary Grade|Final Grade) .*$" --feedback-regexp "Summary Grade 1 - Feedback" --feedback-file /home/gkapfham/working/teaching/github-classroom/feedback/all/feedback.yml --feedback-file /home/gkapfham/working/teaching/github-classroom/feedback/developer-development/feedback-overall-course-assessment.yml --github-token <GitHub Access Token> --github-organization Allegheny-Computer-Science-203-F2023 --github-repository-prefix computer-science-203-fall-2023-course-assessment --transfer-report
poetry run cellveyor --spreadsheet-directory \
/home/gkapfham/working/data/gradebook/2023 --spreadsheet-file CMPSC-203-Fall-2023-Gradebook.xlsx \
--sheet-name Main \
--key-attribute "Student GitHub" \
--key-value "gkapfham" \
--column-regexp "^(Summary Grade|Final Grade) .*$" \
--feedback-regexp "Summary Grade 1 - Feedback" \
--feedback-file /home/gkapfham/working/teaching/github-classroom/feedback/all/feedback.yml \
--feedback-file /home/gkapfham/working/teaching/github-classroom/feedback/developer-development/feedback-overall-course-assessment.yml \
--github-token <Private GitHub Acess Token> \
--github-organization Allegheny-Computer-Science-203-F2023 \
--github-repository-prefix computer-science-203-fall-2023-course-assessment \
--transfer-report
```

0 comments on commit 6073b89

Please sign in to comment.