update: file organization, README; fix: showing averages with grades; add: Makefile
This commit is contained in:
@@ -1,11 +1,34 @@
|
||||
# SOL Enhanced
|
||||
|
||||
An enhanced version of the SkolaOnLine (SOL) online school system.
|
||||
An enhanced version of the ŠkolaOnLine (ŠOL) online school system.
|
||||
|
||||
It aims to provide more readable data than the web version and
|
||||
remove some of the annoyances of the mobile app.
|
||||
remove some of the annoyances of the mobile app. It is intended
|
||||
to be and Android app in the future, but so far it is **only for Linux**
|
||||
(not tested anywhere else).
|
||||
|
||||
Insiration was taken from [@JakubAndrysek](https://github.com/JakubAndrysek)'s [skola-online-stahovani-znamek](https://github.com/JakubAndrysek/skola-online-stahovani-znamek) project.
|
||||
|
||||
## Still in development!
|
||||
#### It is not ready yet.
|
||||
# Features
|
||||
|
||||
+ Shows the schedule for the current week
|
||||
+ Shows all grades and their arithmetic average (not accounting for weight)
|
||||
+ Works offline (when the internet has been accessed at least once before)
|
||||
|
||||
# Usage
|
||||
|
||||
1. Clone the repo
|
||||
|
||||
`git clone git@github.com:mnjx/sol-enhanced.git`
|
||||
|
||||
2. Navigate into the repo directory
|
||||
|
||||
`cd sol-enhanced`
|
||||
|
||||
3. Install the requirements (required to run only once)
|
||||
|
||||
`make install`
|
||||
|
||||
4. Run the program
|
||||
|
||||
`make run`
|
||||
|
||||
Reference in New Issue
Block a user