Files
solon/README.md
T
2023-06-12 06:21:02 +02:00

46 lines
1.6 KiB
Markdown
Executable File

# SOL Enhanced
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. 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.
# 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)
# Installation
**Clone the repo**
`git clone https://github.com/mnjx/sol-enhanced.git`
**Navigate into the repo directory**
`cd sol-enhanced`
**Install** *(superuser privileges required)*
`sudo make install`
**Run the program**
From the repo folder: `make run`
From anywhere on the computer: `solen`
# Usage
Upon startup, the user os prompted to enter their ŠkolaOnLine credentials.
If the login proccess is successfull, the preconfigured functions in `/bin/solen`
will execute. By default, the functions are: showing the schedule for this week,
showing the schedule for today and tomorrow and showing the grades. You can edit
that file if you want to change what is being displayed. Alternatively, you can
edit the `src/main.py` and then do the install step (`sudo make install`).
An option for command-line arguments will be added in the future.