Files
zutui/README.md
2026-02-16 21:30:34 +01:00

60 lines
1.4 KiB
Markdown

# ZUTUI
##### Have you ever felt like visiting https://edziekanat.zut.edu.pl/ is quite annoying?
##### Wouldn't you rather stay in your terminal? Everyone loves terminals...
##### At least I did.
# So here we go!
<img width="100%" height="auto" alt="Login Page" src="https://github.com/user-attachments/assets/081d30f1-75f6-42e4-adbe-c3d67f2ea69c" />
<img width="100%" height="auto" alt="Grades Page" src="https://github.com/user-attachments/assets/6536c74d-13a5-436e-af3d-5522216ce8c1" />
# Usage
## 1. Download:
### On Windows:
```
pip install git+https://github.com/shv187/zutui.git
```
### Arch Linux:
You can use PKGBUILD. Just run:
```bash
makepkg -si
```
or if you want to, you can use AUR helper of your choice. For example:
```bash
yay -S zutui-git
```
### MacOs and other Linux distros:
Most distros environments are externally managed by the system package manager, so the most straightforward way would be using something like `pipx`.
```bash
pipx install git+https://github.com/shv187/zutui.git
```
## 2. Start:
```
zutui
```
## 3. Enjoy :)
# Bindings
`j` - Down
`k` - Up
`enter` - See partial grades info
`ctrl`+`q` - Quit
# Sidenotes
## Config
- On Unix like is stored @ `~/.config/zutui/config.json`
- On Windows is stored @ `~/zutui/config.json`
- so are `grades_cache.json`
##### Feel free to pull request if you're smarter :)
# TODO:
- [x] **Nothing**
- [ ] Open for **requests** tho...
- [ ] And mostlikely **issues** too...