Skip to content

Update README.md Schdule for school periods.io West Chicago Community Highschool (WCCHS) #48

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.

Sign up for GitHub

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

Open
eegerleft wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md Schdule for school periods.io West Chicago Community Highschool (WCCHS) #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
55 changes: 1 addition & 54 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,54 +1 @@
# periods.io timing data
If you would like to add your school to periods.io, allowing for you to easily see the remaining time in class, please follow the below steps and submit a pull request.

We will review the pull request, accept it, and make your schedule live!

## 0. Requirements
You understand YAML syntax to add your schedule. It's fairly simple to learn if you are familiar with basic programming; watch a quick tutorial on YAML if you are new.

## 1. Basics
Every school on periods.io has a name and an ID.
For example, one of our schools is named "Mountain View High School" and has an id of "mvhs". IDs are entirely lowercase and are not seen by the users; it's used internally.

## 2. The Directory
**You need to choose an ID and name for your school.**

Your ID must be unique but the name does not *technically* need to be unique. However, it's what all users will see, so if your school is also named "Mountain View High School," maybe add some more identifying information like "Mountain View High School, New York."

**Check `data/directory.yml` to see all IDs and names for other schools, and add your ID and name to that file, following the other entries as an example.**

## 3. The Folder
Each school has a folder to store its schedule data. Those folders can be found in `data`.

**Create a folder for your school in the `data` directory, naming it the ID you chose for your school.**

## 4. school.yml
Schedule data is stored in two files within the folder you just created. If you poke around some other schools, you'll see a `school.yml` file and a `schedule.yml` file.

**To best complete this file, we recommend you use the `data/mvhs/school.yml` file as a template.**

Fill out the `periods` section of this file with the periods that students should be able to name or add meeting links to (not "Lunch" or "Brunch").

Add each of the possible daily schedules to the file, following the frame for `data/mvhs/school.yml`.

**Do the best you can here. We'll review your work before merging it and can fix any errors.**

## 5. schedule.yml
**Similar to last time, use `data/mvhs/schedule.yml` file as a template**

The `defaults` section allows you to specify a recurring order of schedules that begins on a certain `start` date and cycles indefinitely.

The `calendar` section allows you to override the defaults on specific days or date ranges.

Some example uses for this could be:
```
6/10/2020-8/17/2020 weekend "Summer Break"
9/7/2020 weekend "Labor Day"
10/18/2020 assembly
11/18/2020-11/25/2020 weekend "Thanksgiving Break"
```

## 5. Pull Request
Submit a pull request with your changes. We will review the schedule, correct errors, and suggest changes. Eventually, we will merge it into the repo, and it will go live on periods.io.

Thanks!
[package.json](https://github.com/user-attachments/files/16734331/package.json)