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

readme update #1 #36

Closed
wants to merge 6 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,35 @@ developer-development/feedback-overall-course-assessment.yml \
--github-repository-prefix computer-science-203-fall-2023-course-assessment \
--transfer-report
```

🎉 Introduction

- Cellveyor is a python program that produces assignment reports for students or
classes. Using cellveyor will publicly give grade reports including feedback for
created assignments. Using the cellveyor tool will quickly run and send reports to
members included in a locally created google spreadsheet. By running the command
created, this will quickly and automatically send out these reports in a very timely
and efficient fashion.

😂 Definitions
- Cellveyor (uncountable or singular noun) "a tool that automatically produces a report based output by analyzing a
google sheet"
- Student sentence:
- Instructor sentence: "cellveyor makes it much easier for me to tell my students what their grade looks like
on a certain assignment"
- Researchers sentence: "I found that cellveyor is a very interesting tool that quickly and automatically does
a task that is necessary in schooling"

🔋Features

⚡️ Requirements
- Cellveyor git hub repository
- Local google sheet
- Git hub token

🔽 Installation
Follow these steps to install the cellveyor program:
1. Copy the ssh key of the repo
2. ```Git clone``` the repository onto your personal computer
- ```git clone (ssh key)``
3. type ```poetry run cellveyor --help``` to learn how to use the tool