Skip to content

Commit 89a640f

Browse files
Update README.md
1 parent 1389791 commit 89a640f

File tree

1 file changed

+34
-5
lines changed

1 file changed

+34
-5
lines changed

README.md

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,24 +36,30 @@ A **minimal**, **accurate**, and **blazingly fast** Rubik’s Cube timer for Lin
3636
## 🛠️ Requirements
3737

3838
* Git
39-
* Linux (tested on Arch Linux + Wayland: Hyprland, KDE Plasma 6)
40-
* Rust 1.87 or newer
41-
* Cargo (Rust package manager)
39+
* Any functional OS
40+
* Rust 1.87 or newer (only for manual build)
41+
* Cargo (Rust package manager) (only for manual build)
4242

4343
---
4444

4545
## 📦 Installation
46+
# Option 1 (not recommended but faster download):
47+
# Install from this github page the LSTimer executable file
48+
49+
# Option 2 (recommended but slower, build manually):
4650

4751
**⚠️ Please install packages step-by-step with your correct package manager!**
4852
If unsure, `apt` is likely your package manager (Debian/Ubuntu). Otherwise, search online.
4953

54+
### Linux
55+
5056
```bash
5157
# Install Git
5258
sudo pacman -S git # Arch Linux
5359
sudo apt install git # Debian/Ubuntu
5460

5561
# Clone the repository
56-
git clone https://github.com/Link-the-Coder/LSTimer-Linux.git
62+
git clone https://github.com/Link-the-Coder/LSTimer-Linux.git ~/LSTimer-linux
5763
cd LSTimer-Linux
5864

5965
# Install Cargo
@@ -64,6 +70,29 @@ sudo apt install cargo # Debian/Ubuntu
6470
cargo run --release
6571
```
6672

73+
### Mac
74+
# Option 1 (easier but not recommended):
75+
# Install a file called LSTimer in this github page, and run it
76+
# Drag it into your applications folder on finder
77+
78+
# Option 2 (harder but recommended, much slower):
79+
80+
# Open the terminal app and paste:
81+
82+
```bash
83+
git clone https://github.com/Link-the-Coder/LSTimer-Linux.git ~/LSTimer-linux
84+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
85+
source $HOME/.cargo/env
86+
```
87+
# Close and reopen the terminal
88+
```bash
89+
cd LSTimer-linux
90+
cargo run --release
91+
```
92+
93+
### Windows
94+
# Install the file called LSTimer.exe
95+
6796
💡 **Tip:** For faster startup, run the compiled binary directly:
6897

6998
```bash
@@ -86,7 +115,7 @@ Paste this (replace `/home/yourname` with your actual username):
86115
[Desktop Entry]
87116
Name=LSTimer
88117
Comment=Launch LSTimer Rust App
89-
Exec=/home/yourname/LSTimer-Linux/target/release/LSTimer
118+
Exec=/home/yourname/LSTimer-Linux/LSTimer
90119
Terminal=false
91120
Type=Application
92121
Categories=Utility;

0 commit comments

Comments
 (0)