Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
goody-h authored May 6, 2018
1 parent c922017 commit e90a16f
Showing 1 changed file with 41 additions and 5 deletions.
46 changes: 41 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,59 @@
# Harold - Timetable & (CGPA GPA) Calculator
Feature rich result manager with a semester aware timetable

## Introduction
Easily calculate your GPA and CGPA with this result manager. It works for any university or college and can be customised to meet their grading system.

Tired of writing course lists, get a course list template file from a friend who has written or go online and download available course lists on the app.The course list is available for use in both the timetable and result manager, so write once use twice.

The inbuilt timetable is set to work with the the course list for a particular semester specified by the user. Reminders are scheduled regularly so you wont miss out on important events.

features:
## Users
The app is primarily a utility and educational resource intended for use by students in any higher institution of learning.

## Features
- Unlimited courses per semester
- Allows custom grading grading system
- Downloadable course lists
- Backup and restore of data
- Support for decimal credit units
- Scheduled event reminder

Contributions to the project are welcomed. Read the github section on contributing to know how contributions are being made.
## Releases
Releases are regularly uploaded to [Google play store](https://play.google.com/store/apps/details?id=com.orsteg.harold) in both production and beta stages. Support by downloading tthe latest version of the application and possibly droping a review. You could also opt in for the beta testing program to get early access on future changes to be implemented.

#### Changelog
**V1.0.0-beta**
- Initial test release

## Contributing
This project is open to contributions. Areas of focus should include:
- Layout inprovement to meet material design standard and specifications
- Code optimisation for better user experience
- Bug fixes
- Improvement of [readme](Readme.md) file

#### Further implementations
- Exporting of result to pdf file.
- Design of a beginners guide to using application.
- Other creative ideas

#### Rules
1. Submit an issue describing your proposed change to the application.
2. Fork the repo if you haven't, implement and test your changes.
3. Any other classess created could be written either in `java` or `kotlin`, but `kotlin` would be prefered.
4. Public methods created within classes should be well documented.
5. No particular coding style is enforced. Try making your code as clear as possible.
6. Ensure that all your changes are on the master branch.
7. Submit a pull request for your changes to be implemented.


## Conclusion
This project aims at creating a first class utility and educational software for students in higher institutions of learning. It is my hope that with your help and support this will become a reality. Thank you.

Contact
email us at [email protected] for further inquiries
## License
This project is licenced under the GNU Affero General Public License v3.0. Read the [license](LICENSE) statement for more information.

Enjoy the app !
## Contact
- Support: [email protected]
- Developer: [email protected]

0 comments on commit e90a16f

Please sign in to comment.