Skip to content

Commit 5542054

Browse files
docs: Update README with download links, known issues, and contributing info
1 parent 9325f84 commit 5542054

File tree

1 file changed

+31
-6
lines changed

1 file changed

+31
-6
lines changed

README.md

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,45 @@ Transform your ideas into custom 3D-printable knobs using natural language and A
2020

2121
## Download
2222

23-
### Latest Release: v1.0.0
24-
25-
#### Linux
26-
- [AppImage](../../releases/download/v1.0.0/AlphaForge-Knob-Modeler-1.0.0.AppImage) (134 MB) - Portable, runs anywhere
27-
- [.deb Package](../../releases/download/v1.0.0/alphaforge-ai-knob-modeler_1.0.0_amd64.deb) (85 MB) - Ubuntu/Debian installer
23+
### Latest Release: v1.0.1
2824

2925
#### Windows
30-
- Coming soon
26+
- [Installer (.exe)](../../releases/download/v1.0.1/AlphaForge.Knob.Modeler.Setup.1.0.1.exe) (Recommended)
27+
- [Portable (.exe)](../../releases/download/v1.0.1/AlphaForge.Knob.Modeler.1.0.1.exe)
28+
29+
#### Linux
30+
- [AppImage](../../releases/download/v1.0.1/AlphaForge.Knob.Modeler-1.0.1.AppImage) (Portable)
3131

3232
#### macOS
3333
- Coming soon
3434

3535
---
3636

37+
## Important Notice
38+
39+
**⚠️ This is a Beta/Initial Release (v1.0.x)**
40+
41+
AlphaForge is currently in early development. While fully functional, you may encounter bugs or rough edges.
42+
43+
### Known Issues
44+
- **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.
45+
- **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).
46+
47+
---
48+
49+
## Contributing & Help Wanted
50+
51+
We are a small open-source project and **help is very welcome!**
52+
53+
If you are a developer, 3D printing enthusiast, or UI/UX designer, here is how you can help:
54+
- **Test:** Download the app, print some knobs, and report your results.
55+
- **Code:** Check the "Issues" tab for bugs or feature requests.
56+
- **Documentation:** Improve our guides and examples.
57+
58+
Feel free to open an issue or submit a pull request!
59+
60+
---
61+
3762
## Installation
3863

3964
### Linux

0 commit comments

Comments
 (0)