add readme
This commit is contained in:
parent
a33b411d24
commit
310a60b1a2
1 changed files with 59 additions and 2 deletions
61
README.md
61
README.md
|
|
@ -1,3 +1,60 @@
|
|||
# RonRunner
|
||||
## About
|
||||
|
||||
Riichi tournament manager
|
||||
RonRunner is a lightweight tournament scoring application for Mahjong.
|
||||
|
||||
## Features
|
||||
|
||||
- Add and manage players
|
||||
- Create and edit tournament tables
|
||||
- Automatic score calculation with ranking
|
||||
- Dark modern UI with Segoe UI fonts
|
||||
- Lightweight and fast
|
||||
|
||||
## Installation
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Python 3.8+
|
||||
- Tkinter
|
||||
|
||||
### Linux (Arch)
|
||||
|
||||
```bash
|
||||
sudo pacman -S python python-tkinter
|
||||
git clone https://github.com/Didictateur/RonRunner.git
|
||||
cd RonRunner
|
||||
chmod +x ronrunner_1.0~beta1-1/usr/bin/ronrunner
|
||||
./ronrunner_1.0~beta1-1/usr/bin/ronrunner
|
||||
```
|
||||
|
||||
### Linux (Debian/Ubuntu)
|
||||
|
||||
```bash
|
||||
sudo apt install python3 python3-tk
|
||||
git clone https://github.com/Didictateur/RonRunner.git
|
||||
cd RonRunner
|
||||
chmod +x ronrunner_1.0~beta1-1/usr/bin/ronrunner
|
||||
./ronrunner_1.0~beta1-1/usr/bin/ronrunner
|
||||
```
|
||||
|
||||
### Linux (Fedora)
|
||||
|
||||
```bash
|
||||
sudo dnf install python3 python3-tkinter
|
||||
git clone https://github.com/Didictateur/RonRunner.git
|
||||
cd RonRunner
|
||||
chmod +x ronrunner_1.0~beta1-1/usr/bin/ronrunner
|
||||
./ronrunner_1.0~beta1-1/usr/bin/ronrunner
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
1. Launch the application
|
||||
2. Add players using the input field
|
||||
3. Create tables and assign players
|
||||
4. Edit table scores as needed
|
||||
5. Scores update automatically with ranking
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Loading…
Reference in a new issue