Skip to content

Commit 5b4c480

Browse files
gary-kimgary-kim
committed
Merge pull request #21 from gary-kim/enh/noid/readme
Adjust readme and contributing
2 parents a623f8e + c358869 commit 5b4c480

File tree

2 files changed

+109
-72
lines changed

2 files changed

+109
-72
lines changed

‎CONTRIBUTING.md‎

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,40 @@ Signed-off-by: Random J Developer <[email protected]>
5050

5151
Once you fix an issue or add/improve a feature, make a pull request to this repository. Your pull request will be tested automatically, manually reviewed and, hopefully, get merged into the project and released as part of the next release. Your name will also be added to the changelog and to an `CONTRIBUTORS.md` file to credit your change.
5252

53-
By making a contribution to SAS Powerschool Enhancement Suite, you provide a [AGPL-3.0-only](/LICENSE) license.
53+
By making a contribution to SAS Powerschool Enhancement Suite, you provide a [AGPL-3.0-only](/LICENSE) license but you keep copyright ownership of your contribution.
54+
55+
### License Header
56+
57+
If you modify an exisiting file, add your copyright notice to the file. Something like this:
58+
```
59+
@copyright Copyright (c) <year> <your name> <<your email address>>
60+
```
61+
For a new file, add this license header to the top of the file:
62+
```
63+
/**
64+
*
65+
* @copyright Copyright (c) <year> <your name> <<your email address>>
66+
*
67+
* @author <your name> <<your email address>>
68+
*
69+
* @license GNU AGPL version 3
70+
*
71+
* SAS Powerschool Enhancement Suite - A browser extension to improve the experience of SAS Powerschool.
72+
*
73+
* This program is free software: you can redistribute it and/or modify
74+
* it under the terms of the GNU Affero General Public License as
75+
* published by the Free Software Foundation, version 3.
76+
*
77+
* This program is distributed in the hope that it will be useful,
78+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
79+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
80+
* GNU General Public License for more details.
81+
*
82+
* You should have received a copy of the GNU Affero General Public License
83+
* along with this program. If not, see <https://www.gnu.org/licenses/>.
84+
*
85+
*/
86+
```
5487

5588
### Developer Certificate of Origin
5689
```

‎README.md‎

Lines changed: 75 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,75 @@
1-
# SAS Powerschool Enhancement Suite
2-
3-
[![Build Status](https://img.shields.io/drone/build/gary-kim/saspes?server=https%3A%2F%2Fghdrone.garykim.dev)](https://ghdrone.garykim.dev/gary-kim/saspes)
4-
[![Build Status](https://api.travis-ci.com/gary-kim/saspes.svg?branch=master)](https://travis-ci.com/gary-kim/saspes)
5-
[![Firefox Addon](https://img.shields.io/badge/Firefox%20Addon-Download-brightgreen.svg)](https://github.com/gary-kim/saspes/releases)
6-
[![Chrome Web Store](https://img.shields.io/chrome-web-store/v/ehnkngeidilnoabcjjimkomcggndbhnk.svg)](https://chrome.google.com/webstore/detail/sas-powerschool-enhanceme/ehnkngeidilnoabcjjimkomcggndbhnk)
7-
[![Chrome Web Store](https://img.shields.io/chrome-web-store/users/ehnkngeidilnoabcjjimkomcggndbhnk.svg?label=chrome%20web%20store%20users)](https://chrome.google.com/webstore/detail/sas-powerschool-enhanceme/ehnkngeidilnoabcjjimkomcggndbhnk)
8-
[![GitHub](https://img.shields.io/github/license/gary-kim/saspes.svg)](https://github.com/gary-kim/saspes/blob/master/LICENSE)
9-
[![GitHub issues](https://img.shields.io/github/issues/gary-kim/saspes.svg)](https://github.com/gary-kim/saspes/issues)
10-
11-
12-
![SAS PES](https://cdn.ydgkim.com/gschool/saspes/mainimage.png)
13-
14-
SAS PES is an extension using the WebExtension standard for use by **Singapore American School students only**. The extension provides various enhancements when using Powerschool at SAS.
15-
16-
![](https://cdn.ydgkim.com/gschool/saspes/img1.png)
17-
18-
![](https://cdn.ydgkim.com/gschool/saspes/img2.png)
19-
20-
![](https://cdn.ydgkim.com/gschool/saspes/img3.png)
21-
22-
## Features
23-
24-
### Main Page
25-
* View final percent for each course
26-
* View current semester GPA
27-
* Recalculate semester GPA with custom hypothetical grades.
28-
29-
### Class Page
30-
* View final percent and cutoffs for grades
31-
* Recalculate final percent and grade with an extra assignment
32-
33-
### Extra Features
34-
* (Temporarily removed for development [#4](https://github.com/gary-kim/saspes/issues/4) ) ~~View grades and final percents for courses even when Powerschool is closed.~~
35-
36-
37-
## Browser Support
38-
39-
### Offically Supported
40-
41-
* Firefox
42-
* Chromium
43-
44-
Please be aware that the extension is mainly designed for use in Firefox.
45-
46-
### Unoffical Support
47-
48-
People have gotten the extension to work on the following browsers
49-
50-
* Opera
51-
* Vivaldi
52-
53-
## Download
54-
55-
Download for Chromium can be found on [chrome web store](https://chrome.google.com/webstore/detail/sas-powerschool-enhanceme/ehnkngeidilnoabcjjimkomcggndbhnk) and for Firefox, please check [releases](https://github.com/gary-kim/saspes/releases/).
56-
57-
## Contributing
58-
59-
[CONTRIBUTING.md](/CONTRIBUTING.md)
60-
61-
## 3rd Party Libraries
62-
63-
Refer to the [libraries.txt](/libraries.txt).
64-
65-
## License
66-
67-
Copyright &copy; 2018-2019 Gary Kim &lt;<[email protected]>&gt;
68-
69-
Source code licensed under AGPL-3.0-only
70-
71-
The logo and name are not licensed for use, modification, or distribution.
1+
<p align="center">
2+
<img src="https://cdn.ydgkim.com/gschool/saspes/mainimage.png" alt="SAS Powerschool Enhancement Suite" height="200">
3+
</p>
4+
5+
[![Build Status](https://img.shields.io/drone/build/gary-kim/saspes?server=https%3A%2F%2Fghdrone.garykim.dev)](https://ghdrone.garykim.dev/gary-kim/saspes)
6+
[![Build Status](https://api.travis-ci.com/gary-kim/saspes.svg?branch=master)](https://travis-ci.com/gary-kim/saspes)
7+
[![Firefox Addon](https://img.shields.io/badge/Firefox%20Addon-Download-brightgreen.svg)](https://github.com/gary-kim/saspes/releases)
8+
[![Chrome Web Store](https://img.shields.io/chrome-web-store/v/ehnkngeidilnoabcjjimkomcggndbhnk.svg)](https://chrome.google.com/webstore/detail/sas-powerschool-enhanceme/ehnkngeidilnoabcjjimkomcggndbhnk)
9+
[![Chrome Web Store](https://img.shields.io/chrome-web-store/users/ehnkngeidilnoabcjjimkomcggndbhnk.svg?label=chrome%20web%20store%20users)](https://chrome.google.com/webstore/detail/sas-powerschool-enhanceme/ehnkngeidilnoabcjjimkomcggndbhnk)
10+
[![GitHub](https://img.shields.io/github/license/gary-kim/saspes.svg)](https://github.com/gary-kim/saspes/blob/master/LICENSE)
11+
[![GitHub issues](https://img.shields.io/github/issues/gary-kim/saspes.svg)](https://github.com/gary-kim/saspes/issues)
12+
13+
14+
SAS PES is an extension using the WebExtension standard for use by **Singapore American School students only**. The extension provides various enhancements when using Powerschool at SAS.
15+
16+
<p align="center">
17+
<img src="https://cdn.ydgkim.com/gschool/saspes/img1.png" height="250">
18+
</p>
19+
<p align="center">
20+
<img src="https://cdn.ydgkim.com/gschool/saspes/img2.png" height="250">
21+
</p>
22+
<p align="center">
23+
<img src="https://cdn.ydgkim.com/gschool/saspes/img3.png" height="250">
24+
</p>
25+
26+
## Features
27+
28+
### Main Page
29+
* View final percent for each course
30+
* View current semester GPA
31+
* Recalculate semester GPA with custom hypothetical grades.
32+
33+
### Class Page
34+
* View final percent and cutoffs for grades
35+
* Recalculate final percent and grade with an extra assignment
36+
37+
### Extra Features
38+
* (Temporarily removed for development [#4](https://github.com/gary-kim/saspes/issues/4) ) ~~View grades and final percents for courses even when Powerschool is closed.~~
39+
40+
41+
## Browser Support
42+
43+
### Offically Supported
44+
45+
* Firefox
46+
* Chromium
47+
48+
Please be aware that the extension is mainly designed for use in Firefox.
49+
50+
### Unoffical Support
51+
52+
People have gotten the extension to work on the following browsers
53+
54+
* Opera
55+
* Vivaldi
56+
57+
## Download
58+
59+
Download for Chromium can be found on [chrome web store](https://chrome.google.com/webstore/detail/sas-powerschool-enhanceme/ehnkngeidilnoabcjjimkomcggndbhnk) and for Firefox, please check [releases](https://github.com/gary-kim/saspes/releases/).
60+
61+
## Contributing
62+
63+
[CONTRIBUTING.md](/CONTRIBUTING.md)
64+
65+
## 3rd Party Libraries
66+
67+
Refer to the [libraries.txt](/libraries.txt).
68+
69+
## License
70+
71+
Copyright &copy; 2018-2019 Gary Kim &lt;<[email protected]>&gt;
72+
73+
Source code licensed under AGPL-3.0-only
74+
75+
The logo and name are not licensed for use, modification, or distribution.

0 commit comments

Comments
 (0)