kjao/archive
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Kenneth Jao 2017-02-08 01:15:55 -05:00
parent 81fff55790
commit 331a41a991
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
hourglass/README.md
View File

@ -8,13 +8,13 @@ How to use Hourglass:
If you find any bugs or have an idea to make this better, you can press the question mark on the sidebar.
### Main Page
After logging in with a Google account and setting up your profile, you will redirect to this page. Here, you can view work from subscribed classes. The left sidebar has three modes: Main, Settings, and Feedback.
#### Main
### Main
This will allow changing modes: class mode, and calendar mode. It also allows filters for all of the subscribed classes. Hovering over classes will highlight their respective works, and clicking on a class will filter them, only displaying those filtered. You can filter more than one class at a time or filter by the type of work.
##### Calendar Mode
Calendar mode organizes work by due date rather than by class. Pressing on a date will open the left sidebar, allowing you to choose a class in which you want to create the work.
##### Class Mode
Class mode allows you to organize work by the class it belongs to. You can drag classes to reorder them.
#### Settings
### Settings
This will allow changing preferences, including: Theme, Default Mode, Hide Homework, Hide Done, and Hide Reported, which are fairly self-explanatory. Additionally, this allows managing classes, where you can manage, join, and create classes.
##### Manage Classes
Here, you can see details of the class. If you are an admin of the class, clicking on it will allow you to manage details about the class. Otherwise, you can leave the class by clicking the X.
@ -22,7 +22,7 @@ Here, you can see details of the class. If you are an admin of the class, clicki
Join a public class by searching for and then clicking on the class you want to join. Joining a private class requires a code provided by the class administrator, which you enter in the field provided after clicking the "Join Private Class" button.
##### Create Classes
After filling out class details, class creators must wait for the class to be approved by administrators. Public classes can be viewed and joined by all, while private classes are hidden from others and require a code to join.
#### Feedback
### Feedback
As mentioned earlier, send us feedback here, to know what we should improve on, or things that you want to add.
##### Work
Every piece of work has a confirmed to reported ratio. This is the ratio of the number of people who confirm the validity of the work to the number of people who believe that this is a false report. The creator of a work can edit fields after creation by clicking on details needed to be changed. Lastly, by marking a work as done, it is hidden from view. To disable this, go to preferences.