Skip to content

Commit 466533d

Browse files
Update README.md
1 parent 4719325 commit 466533d

File tree

1 file changed

+35
-6
lines changed

1 file changed

+35
-6
lines changed

README.md

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# **LSTimer-Linux**
1+
# **LSTimer**
22

33
An **accurate**, and **fast** Rubik’s Cube timer for every OS, built with Rust.
44

@@ -36,7 +36,7 @@ An **accurate**, and **fast** Rubik’s Cube timer for every OS, built with Rust
3636
## 🛠️ Requirements
3737

3838
* Git
39-
* Linux (tested on Arch Linux + Wayland: Hyprland, KDE Plasma 6)
39+
* Any functional operation system (windows, mac, linux)
4040
* Rust 1.87 or newer
4141
* Cargo (Rust package manager)
4242

@@ -47,10 +47,17 @@ An **accurate**, and **fast** Rubik’s Cube timer for every OS, built with Rust
4747
**⚠️ Please install packages step-by-step with your correct package manager!**
4848
If unsure, `apt` is likely your package manager (Debian/Ubuntu). Otherwise, search online.
4949

50+
### Linux:
51+
52+
# 1st option (not recommended):
53+
# Install in this github page directly the executable file called LSTimer for no commands
54+
# 2nd option (slower install but recommended):
55+
5056
```bash
5157
# Install Git
5258
sudo pacman -S git # Arch Linux
5359
sudo apt install git # Debian/Ubuntu
60+
sudo xbps-install -S git # Void
5461

5562
# Clone the repository
5663
git clone https://github.com/Link-the-Coder/LSTimer-Linux.git
@@ -62,31 +69,53 @@ sudo apt install cargo # Debian/Ubuntu
6269

6370
# Run the app in release mode
6471
cargo run --release
72+
73+
# Or simply run the executable file:
74+
./LSTimer
75+
```
76+
77+
### Mac
78+
79+
# 1st option (not recommended):
80+
# Install in this github page directly the executable file called LSTimer for no commands
81+
# 2nd option (slower install but recommended):
82+
83+
```bash
84+
# Clone the repository
85+
git clone https://github.com/Link-the-Coder/LSTimer-Linux.git
86+
cd LSTimer-Linux
87+
./LSTimer
6588
```
89+
# Drag the executable inside your apps folder in the finder.
90+
91+
## Windows
92+
# In this github page, click on a file called LSTimer.exe
93+
# Install it
94+
# Run it
6695

67-
💡 **Tip:** For faster startup, run the compiled binary directly:
96+
💡 **Tip:** For faster startup, run the compiled binary directly (linux):
6897

6998
```bash
7099
./target/release/LSTimer
71100
```
72101

73102
---
74103

75-
## 🖥️ Optional: Create Desktop Shortcut
104+
## 🖥️ Optional: Create Desktop Shortcut (linux)
76105

77106
Open or create the desktop entry file:
78107

79108
```bash
80109
nano ~/.local/share/applications/LSTimer.desktop
81110
```
82111

83-
Paste this (replace `/home/yourname` with your actual username):
112+
Paste this (replace `$HOME` with your actual /homer/username for extra safety):
84113

85114
```ini
86115
[Desktop Entry]
87116
Name=LSTimer
88117
Comment=Launch LSTimer Rust App
89-
Exec=/home/yourname/LSTimer-Linux/target/release/LSTimer
118+
Exec=$HOME/LSTimer-Linux/target/release/LSTimer
90119
Terminal=false
91120
Type=Application
92121
Categories=Utility;

0 commit comments

Comments
 (0)