Skip to content

Commit 6761684

Browse files
authored
Update README.md
1 parent 70e2e66 commit 6761684

File tree

1 file changed

+49
-7
lines changed

1 file changed

+49
-7
lines changed

README.md

Lines changed: 49 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,58 @@
11
# Veltrix
22

3-
🚀 **Veltrix** is a Rust + [egui](https://github.com/emilk/egui) based **GUI tool for managing NBFC (NoteBook FanControl)** configs.
3+
Veltrix is a lightweight **Rust + [egui](https://github.com/emilk/egui)** desktop application for managing [NBFC (NoteBook FanControl)](https://github.com/nbfc-linux/nbfc-linux) configurations on Linux.
44

5-
### Prerequisites
6-
- Rust (latest stable) → [Install Rust](https://www.rust-lang.org/tools/install)
7-
- [NBFC Linux](https://github.com/hirschmann/nbfc-linux) installed and accessible from terminal (`nbfc`)
5+
👉 [Download the latest release](https://github.com/ERFouX/Veltrix/releases)
6+
7+
---
8+
9+
## 📦 Prerequisites
10+
11+
Make sure you have the following installed:
12+
13+
* [Rust (latest stable)](https://www.rust-lang.org/tools/install)
14+
* [NBFC Linux](https://github.com/nbfc-linux/nbfc-linux) (must be accessible via `nbfc` in your terminal)
15+
16+
---
17+
18+
## 🔧 Build from source
819

9-
### Clone and build
1020
```bash
1121
git clone https://github.com/ERFouX/Veltrix.git
1222
cd Veltrix
1323
cargo build --release
1424
```
15-
### Preview v0.1.0
16-
<img width="492" height="585" alt="image" src="https://github.com/user-attachments/assets/d244aeda-1cb2-409c-85d2-f1df121c7396" />
25+
26+
The compiled binary will be available in:
27+
28+
```
29+
target/release/veltrix
30+
```
31+
32+
---
33+
34+
## 📸 Preview
35+
36+
**Veltrix v0.1.0**
37+
38+
<img width="492" height="585" alt="Veltrix screenshot" src="https://github.com/user-attachments/assets/d244aeda-1cb2-409c-85d2-f1df121c7396" />
39+
40+
---
41+
42+
## 🛠 Roadmap
43+
44+
* [ ] Profile editing from GUI
45+
* [ ] Autostart support
46+
* [ ] Windows support (future)
47+
48+
---
49+
50+
## 🤝 Contributing
51+
52+
Pull requests and issues are welcome. If you’d like to add features or improve Veltrix, feel free to open a discussion.
53+
54+
---
55+
56+
## 📜 License
57+
58+
MIT License – see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)