@@ -17,8 +17,8 @@ found as openAPI schemas.
1717
1818## Installation
1919
20- Be aware that Thanix currently is only developed on and for Linux distributions.< br >
21- Support for other operating systems may be available in the future, but currently though it is not guaranteed to work .
20+ > [ !Note ]
21+ > Thanix is primary developed for Linux distributions. Windows and MacOS support are provided "as-is" .
2222
2323### Building from source
2424
@@ -81,7 +81,7 @@ To install it simply run:
8181cargo install thanix
8282```
8383
84- ### Install Thanix as a distribution package (TBA )
84+ ### Install Thanix as a distribution package (Work in Progress )
8585
8686We are working on building packages for a variety of Linux distributions starting with ` openSUSE Tumbleweed ` .
8787
@@ -109,6 +109,50 @@ Zypper should now install Thanix for you.
109109> If you do not wish to deal with this, we suggest you install Thanix using one of the methods listed above.
110110> Thank you for understanding.
111111
112+ ### Windows
113+
114+ 1 . Download the latest Windows release from [ GitHub Releases] ( https://github.com/The-Nazara-Project/Thanix/releases/latest ) .
115+ - Look for ` thanix-x86_64-pc-windows-msvc.zip ` .
116+
117+ 2 . Extract the ` .zip ` somewhere convenient.
118+
119+ 3 . (Optional) Add the directory containing ` thanix.exe ` to your ` PATH ` environment variable:
120+ - Press ` Win + X ` -> System -> Advanced system settings -> Environment Variables -> Path -> Add new path.
121+
122+ 4 . Open a Command Prompt or PowerShell and run Thanix:
123+
124+ ``` powershell
125+ thanix.exe input.yaml -o my_crate
126+ ```
127+
128+ ### MacOS
129+
130+ > [ !Warning]
131+ > MacOS release workflow is very experimental and cannot be easily verified at this time.
132+
133+ 1 . Download the latest macOS release from [ GitHub Releases] ( https://github.com/The-Nazara-Project/Thanix/releases/latest ) .
134+ - Look for ` thanix-86_64-apple-darwin.tar.gz `
135+
136+ 2 . Extract the tarball
137+
138+ ``` bash
139+ tar -xzf thanix-x86_64-apple-darwin.tar.gz
140+ ```
141+
142+ 3 . Move the binary directory to your ` PATH ` , e.g ` /usr/local/bin ` :
143+
144+ ``` bash
145+ mv thanix /usr/local/bin/
146+ chmod +x /usr/local/bin/thanix
147+ ```
148+
149+ 4 . Run Thanix from the terminal
150+
151+ ``` bash
152+ # Example usage
153+ thanix input.yaml -o output.rs
154+ ```
155+
112156## Usage
113157
114158After you have installed Thanix in a way you see fit, you use it by passing it ** two mandatory parameters** like this:
0 commit comments