ceskadraha/README.md

68 lines
1.6 KiB
Markdown

# čd (České dráhy)
A fun terminal animation of a Czech Railways motorak (railcar) - the Czech version of the classic `sl` command.
```
___
| |___
_____________ |___|___| _______________
| ___ ___ |=|_________|==|___ ___ |
| | | | || O O | | | | | |
|_|___|__|___||___\_____/___|__|__|__|___|__|
\_O_/ \_O_/ \_______/ \_O_/ \_O_/
České dráhy - Motorák 810
```
Inspired by the legendary `sl` command, but featuring the iconic ČD Class 810/810.0 "Orchestrion" motorak.
## Installation
### Manual Installation
```bash
git clone https://git.hswro.org/mab122/ceskadraha.git
cd ceskadraha
sudo make install
```
### Manual (without make)
```bash
sudo cp čd /usr/local/bin/
sudo chmod +x /usr/local/bin/čd
```
## Usage
```bash
čd # Run the animation (left to right)
čd -r # Run in reverse (right to left)
čd -h # Show help
```
## Features
- Animated Czech Railways Class 810 motorak
- Reverse direction support
- Animated exhaust/smoke
- Terminal width aware
- Thank you message in Czech: "Děkujeme, že jste cestovali s Českými drahami!"
## Why?
Just like the original `sl` command was created to punish users who mistype `ls`, this is for Czech railway enthusiasts who want a bit of fun in their terminal. Or maybe you just really like Czech motoráks.
## Requirements
- Bash
- `tput` command (usually part of ncurses)
## License
MIT License - See LICENSE file for details
## Credits
Inspired by the classic `sl` (Steam Locomotive) command by Toyoda Masashi.