From 6073b89e0f49e4a1049bc93a07292caa355051f1 Mon Sep 17 00:00:00 2001 From: "Gregory M. Kapfhammer" Date: Tue, 31 Oct 2023 12:01:45 -0400 Subject: [PATCH] docs: Give a better example of the example command in the README.md file. --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 424f8c5..f8cb7cb 100644 --- a/README.md +++ b/README.md @@ -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-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 \ +--github-organization Allegheny-Computer-Science-203-F2023 \ +--github-repository-prefix computer-science-203-fall-2023-course-assessment \ +--transfer-report ```