44![ Platform] ( https://img.shields.io/badge/platform-Windows%20%7C%20Linux%20%7C%20macOS-blue )
55![ License] ( https://img.shields.io/badge/license-MIT-green )
66
7-
8-
97---
108
119## ✨ Features
2321> ⚠ ** .NET 9.0 SDK or newer is recommended**
2422
2523``` bash
24+ # Clone the repository
2625git clone https://github.com/UndefinedClear/Storm.git
2726cd Storm
27+
28+ # Quick build (automatically selects SDK version)
2829dotnet build
29- ````
30+ ```
31+
32+ ### ⚡ Automated Build
33+
34+ You can also use the provided build scripts to generate a standalone executable in the ` publish ` folder:
35+
36+ - ** Windows:** Run ` Storm/build.bat `
37+ - ** Linux:** Run ` Storm/build.sh ` (make sure to ` chmod +x build.sh ` first)
38+
39+ These scripts create a self-contained, single-file release.
40+ `
3041
3142Or download the latest build from the ** Releases** section.
3243
@@ -91,9 +102,9 @@ Each operation is versioned with a timestamp, making recovery simple and reliabl
91102
92103## ⚙ Requirements
93104
94- * ** .NET 9.0 SDK (recommended)**
95- * Windows, Linux, or macOS
96- * Terminal with ANSI color support
105+ - ** .NET 9.0 SDK (recommended)**
106+ - Windows, Linux, or macOS
107+ - Terminal with ANSI color support
97108
98109---
99110
@@ -114,9 +125,9 @@ Open an issue here:
114125
115126Please include:
116127
117- * What happened
118- * Steps to reproduce
119- * Your OS and Storm version
128+ - What happened
129+ - Steps to reproduce
130+ - Your OS and Storm version
120131
121132---
122133
@@ -131,8 +142,8 @@ Pull Requests are welcome!
131142
132143Before submitting, please:
133144
134- * Follow the existing code style
135- * Test your changes
145+ - Follow the existing code style
146+ - Test your changes
136147
137148---
138149
@@ -147,14 +158,14 @@ Small PRs are reviewed faster 😉
147158
148159Planned improvements and upcoming features:
149160
150- * [ ] Auto-clean old history versions
151- * [ ] Config file support (` storm.config` )
152- * [ ] Ignore patterns (like ` .gitignore` )
153- * [ ] Restore preview before confirming
154- * [ ] Compression for stored versions
155- * [ ] Global install via ` dotnet tool`
156- * [ ] Interactive TUI mode
157- * [ ] Performance improvements for large directories
161+ - [ ] Auto-clean old history versions
162+ - [ ] Config file support (` storm.config ` )
163+ - [ ] Ignore patterns (like ` .gitignore ` )
164+ - [ ] Restore preview before confirming
165+ - [ ] Compression for stored versions
166+ - [ ] Global install via ` dotnet tool `
167+ - [ ] Interactive TUI mode
168+ - [ ] Performance improvements for large directories
158169
159170Have an idea? Open an issue and share it!
160171
0 commit comments