Mon Jun 12 06:03:14 CEST 2023

README.md

@@ -15,20 +15,31 @@ Insiration was taken from [@JakubAndrysek](https://github.com/JakubAndrysek)'s [
 + Shows all grades and their arithmetic average (not accounting for weight)
 + Works offline (when the internet has been accessed at least once before)
 
-# Usage
+# Installation
 
-Clone the repo  
+**Clone the repo**  
 
-`git clone git@github.com:mnjx/sol-enhanced.git`  
+`git clone https://github.com/mnjx/sol-enhanced.git`  
 
-Navigate into the repo directory  
+**Navigate into the repo directory**  
 
 `cd sol-enhanced`  
 
-Install the requirements (required to run only once)  
+**Install** *(superuser privileges required)*  
 
-`make install`  
+`sudo make install`  
 
-Run the program  
+**Run the program**  
 
-`make run`  
+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.