Skip to content

Commit de6e58c

Browse files
Create README.md
1 parent e768e5f commit de6e58c

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# LSTimer-Linux
2+
3+
**LSTimer** is a minimal and efficient Rubik's Cube timer for Linux, built in Rust.
4+
5+
## 🚀 Features
6+
- Fast and responsive terminal-based interface
7+
- Accurate WCA-style timing
8+
- Scramble generator
9+
- Session stats tracking (coming soon)
10+
11+
## 🛠 Requirements
12+
- Linux (tested on Arch)
13+
- Rust (1.87+)
14+
15+
## 📦 Installation
16+
17+
```bash
18+
git clone https://github.com/Link-the-Coder/LSTimer-Linux.git
19+
cd LSTimer-Linux
20+
cargo run --release
21+
```
22+
23+
🧠 Usage
24+
25+
Press Space to start/stop the timer
26+
27+
Wait for the green light before starting
28+
29+
Automatically generates a scramble on each solve
30+
31+
🔒 License
32+
33+
All rights reserved.
34+
You may view the source code but may not redistribute, reuse, or modify it.
35+
36+
Made by Link-the-Coder 💻
37+
38+
39+
---
40+
41+
To add it:
42+
43+
```bash
44+
echo "[PASTE ABOVE HERE]" > README.md
45+
git add README.md
46+
git commit -m "Add README"
47+
git push
48+
```

0 commit comments

Comments
 (0)