Skip to content

Commit 6ae737c

Browse files
docs: Update README with Windows install info and solo dev language
1 parent 8c974b2 commit 6ae737c

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -51,43 +51,47 @@ Transform your ideas into custom 3D-printable knobs using natural language and A
5151
AlphaForge is currently in early development. While fully functional, you may encounter bugs or rough edges.
5252

5353
### Known Issues
54-
- **Shaft Diameter Accuracy:** The hole diameter for the shaft may be slightly tight or loose depending on your printer's calibration. We are aware that the tolerance calculation needs adjustment.
54+
- **Shaft Diameter Accuracy:** The hole diameter for the shaft may be slightly tight or loose depending on your printer's calibration. I am aware that the tolerance calculation needs adjustment.
5555
- **Workaround:** For now, you can slightly adjust the "Shaft Diameter" slider in the "Shaft Fit" section to compensate for your printer's tolerance (e.g., add 0.2mm - 0.4mm).
5656

5757
---
5858

5959
## Contributing & Help Wanted
6060

61-
We are a small open-source project and **help is very welcome!**
61+
I am an independent open-source developer and **help is very welcome!**
6262

6363
If you are a developer, 3D printing enthusiast, or UI/UX designer, here is how you can help:
6464
- **Test:** Download the app, print some knobs, and report your results.
6565
- **Code:** Check the "Issues" tab for bugs or feature requests.
66-
- **Documentation:** Improve our guides and examples.
66+
- **Documentation:** Improve my guides and examples.
6767

6868
Feel free to open an issue or submit a pull request!
6969

7070
---
7171

7272
## Installation
7373

74+
### Windows
75+
76+
1. Download the **Setup** `.exe` file from the [latest release](../../releases/latest).
77+
2. Run the installer.
78+
3. The app will launch automatically.
79+
4. (Optional) You can also use the **Portable** version if you prefer not to install it.
80+
7481
### Linux
7582

7683
**AppImage (Recommended)**
7784
```bash
78-
# Download and make executable
79-
chmod +x AlphaForge-Knob-Modeler-1.0.0.AppImage
80-
./AlphaForge-Knob-Modeler-1.0.0.AppImage
85+
# Download and make executable (replace version number with latest)
86+
chmod +x AlphaForge.Knob.Modeler-1.0.2.AppImage
87+
./AlphaForge.Knob.Modeler-1.0.2.AppImage
8188
```
8289

8390
**Debian/Ubuntu (.deb)**
8491
```bash
85-
sudo dpkg -i alphaforge-ai-knob-modeler_1.0.0_amd64.deb
92+
sudo dpkg -i alphaforge-ai-knob-modeler_1.0.2_amd64.deb
8693
```
8794

88-
### Windows
89-
Coming soon
90-
9195
### macOS
9296
Coming soon
9397

@@ -197,9 +201,10 @@ alphaforge-knob-modeler/
197201

198202
## Roadmap
199203

200-
- [ ] Windows and macOS builds
204+
- [x] Windows builds
205+
- [ ] macOS builds
201206
- [ ] Code signing for trusted distribution
202-
- [ ] Auto-updates via GitHub Releases
207+
- [x] Auto-updates via GitHub Releases
203208
- [ ] Save/Load project files (.knob format)
204209
- [ ] Additional export formats (OBJ, 3MF)
205210
- [ ] Keyboard shortcuts (Ctrl+S, Ctrl+E)

0 commit comments

Comments
 (0)