Skip to content

Commit 67239b5

Browse files
committed
docs: align v0.6.0 release surfaces
1 parent a0a2d95 commit 67239b5

8 files changed

Lines changed: 43 additions & 10 deletions

File tree

MANUAL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -422,7 +422,7 @@ Keep using those for cosmetic/visualization parts (bearings, fans, vitamins).
422422
Swap in tq-threads where you need a *printable* thread rather than a render-only
423423
one.
424424

425-
### TinkerQuarry / KimCad
425+
### TinkerQuarry
426426
MIT is GPL-2.0-compatible, so vendor `tq_threads.scad` into the engine's
427427
`library/` folder and `include` it from generated `.scad`. The plan→geometry
428428
step can call presets by name, e.g. `tq_thread_preset("M8", len)` or

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ with anything. Common combinations (full recipes in **[MANUAL.md](MANUAL.md#inte
138138
|---|---|
139139
| **BOSL2 / BOSL** | Use BOSL2 for attachments, rounding, and shapes; use tq‑threads for the actual threads. No symbol clashes (`tq_*` vs BOSL2's names). Subtract `tq_thread_cutter()` from BOSL2 solids; the `tq_*` parts are normal children you can `attach()` around. |
140140
| **Migrating from Dan Kirshner / rcolyer `threads.scad`** | `metric_thread(d,p,l)``tq_thread(d,p,l)`; `english_thread()``tq_thread_tpi()`; `ScrewThread`/`ScrewHole``tq_thread` / `tq_threaded_hole`; `RodStart/RodEnd``tq_rod_start/tq_rod_end`. See the [migration table](MANUAL.md#migration). |
141-
| **TinkerQuarry / KimCad** | MIT → GPL‑2.0 compatible; vendor `tq_threads.scad` into `library/` and `include` it from generated `.scad`. The generator can call presets by name (`tq_thread_preset("M8", …)`). |
141+
| **TinkerQuarry** | MIT → GPL‑2.0 compatible; vendor `tq_threads.scad` into `library/` and `include` it from generated `.scad`. The generator can call presets by name (`tq_thread_preset("M8", …)`). |
142142
| **Slicers (Orca/Cura/Prusa/Bambu)** | Export STL/3MF; threads are manifold so no repair step is needed. Print **axis vertical** for best flanks. |
143143
| **NopSCADlib / hardware libs** | Use their part catalogs for visualization; use tq‑threads when you need a *printable* thread instead of a cosmetic one. |
144144

docs/architecture.svg

Lines changed: 4 additions & 4 deletions
Loading

docs/discussions/01-welcome.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
screw threads** — ISO metric and Unified (imperial) — plus the everyday hardware
66
built from them: bolts, nuts, washers, tapped/clearance/countersunk holes,
77
standoffs, couplers, countersunk and wood screws, and bottle/cap threads.
8+
The v0.6.0 release also adds flexible printable profile controls: square,
9+
rectangular, narrow-tooth, groove, `side_angle`, `thread_size`, `lead_ends`, and
10+
rate-based taper input.
811

912
### What makes it different
1013
- **Manifold by construction.** Each thread is a single watertight `polyhedron`
@@ -13,6 +16,8 @@ standoffs, couplers, countersunk and wood screws, and bottle/cap threads.
1316
- **Printable-first.** Fit `clearance`, internal-oversize/external-undersize
1417
compensation, lead-in chamfers, rounded roots, and real `$fn/$fa/$fs`
1518
resolution are all parameters.
19+
- **Flexible profiles.** Keep the default ISO/UN basic profile, or choose
20+
full-sharp V, square, rectangular, narrow-tooth, or helical groove forms.
1621
- **Clean-room + MIT.** Built only from public standards (ISO 68-1/261/262/273/
1722
4032/4762/7089/10642, ASME B1.1). MIT is GPL-2.0-compatible, so it drops into
1823
GPL projects unchanged.
@@ -23,6 +28,7 @@ include <tq_threads.scad>;
2328
tq_thread_preset("M8", 20); // M8 rod
2429
difference() { part(); tq_threaded_hole(6,1.0,12); } // tapped hole
2530
tq_bolt(8,1.25,20, head="socket", shank=4); // cap screw
31+
tq_thread(12,4,20, profile="square", thread_size=1.5);
2632
```
2733
See the [README](../../README.md) for install options and the
2834
[MANUAL](../../MANUAL.md) for the full reference.

docs/discussions/02-integrating-and-migrating.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,22 @@ tq-threads is a clean-room **feature** equivalent (different code + API):
3232

3333
Full table + parameters in the [MANUAL](../../MANUAL.md#migration).
3434

35-
## TinkerQuarry / KimCad
35+
## v0.6 profile-control notes
36+
The compatibility default is still `profile="flat"` with the ISO/UN basic
37+
truncations. New controls are optional and forward through `tq_thread_preset()`
38+
and `tq_thread_tpi()`:
39+
40+
```openscad
41+
tq_thread_preset("M8", 20, profile="square", thread_size=1);
42+
tq_thread_tpi(d=0.5*25.4, tpi=8, length=20, profile="rectangle", rect_ratio=1/3);
43+
tq_thread(14, 4, 20, profile="square", groove=true, lead_ends="both");
44+
```
45+
46+
`side_angle=30` is a 60-degree included V using the half-angle-from-perpendicular
47+
convention. Square, rectangular, and groove profiles are generic printable
48+
forms, not standards-certified ACME/trapezoidal/buttress replacements.
49+
50+
## TinkerQuarry
3651
MIT → GPL-2.0 compatible; vendor `tq_threads.scad` into the engine's `library/`
3752
and call presets by name from generated `.scad`.
3853

docs/discussions/03-fdm-tolerance-tuning.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@ Make a bolt **and** its nut with the *same* `clearance` and they fit.
2222
- Print **axis vertical** for the cleanest flanks; no supports in tapped holes.
2323
- Keep lead-in chamfers on (default) so threads self-start.
2424
- `profile="rounded"` for stronger roots on load-bearing parts.
25+
- For v0.6 generic square/rectangular/groove forms, start with the same
26+
`clearance` table, then adjust `thread_size` or `rect_ratio` for printable
27+
flank thickness and strength.
28+
- `fit=` records nominal ISO 965 allowance intent only. On M8 `6g` it is about
29+
0.029 mm diametral, so `clearance` is still the practical FDM fit lever.
2530
- Pitch < ~0.7 mm (fine M2–M3) is at a 0.4 mm nozzle's limit — print slow or use
2631
a heat-set insert.
2732

docs/discussions/04-roadmap-and-requests.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44
What should tq-threads do next? Vote with 👍 and add your own.
55

66
## On the table
7-
- **ACME / trapezoidal** lead-screw profile (non-60°).
7+
- **Standards-accurate ACME / trapezoidal / buttress** lead-screw profiles.
88
- **True ISO internal profile** option (vs. the current external-form cutter).
9-
- **NPT / tapered pipe** threads.
9+
- **Full NPT / tapered pipe** threads (v0.6 only provides the 1:16 taper-rate
10+
reference, not the pipe-thread profile or sealing/gauge behavior).
1011
- **More named hardware presets** (DIN/ISO bolt & nut length series, helicoil sizes).
1112
- **Thread-relief groove** helper (undercut at the thread runout).
1213
- **Knurling** helper for knobs/caps.
@@ -16,6 +17,12 @@ What should tq-threads do next? Vote with 👍 and add your own.
1617
- Cosmetic/vitamin part libraries — pair with NopSCADlib instead.
1718
- A GUI configurator.
1819

20+
## Already in v0.6.0
21+
- Generic printable square and rectangular profiles.
22+
- Narrow-tooth threads via `thread_size`.
23+
- Helical grooves via `groove=true`.
24+
- `side_angle`, `lead_ends`, and `taper_rate=tq_npt_taper_rate()`.
25+
1926
## Ground rules for contributions
2027
tq-threads is **clean-room** and **MIT**. New geometry must come from public
2128
standards + first-principles math, never from another thread library. See

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ <h2>Why tq-threads</h2>
9797
<div class="card"><h3>🖨️ Printable-first</h3><p>Fit clearance, internal-oversize / external-undersize compensation, lead-in chamfers, rounded roots, and real <code>$fn/$fa/$fs</code> are all parameters.</p></div>
9898
<div class="card"><h3>🔩 Batteries included</h3><p><strong>101 presets</strong> (M1.6–M64 coarse + full ISO 261 fine + UNC/UNF #0–1″), plus bolts, nuts, washers, countersunk &amp; wood screws, augers, Phillips drives, clearance/counterbore/countersink holes, standoffs, couplers, and child‑difference <code>tq_tap</code>/<code>tq_drill</code> wrappers. Square, rectangular, narrow-tooth, and groove profiles are generic printable forms; tune <code>clearance</code> for FDM fit.</p></div>
9999
<div class="card"><h3>⚖️ MIT licensed</h3><p>Permissive <em>and</em> GPL-2.0-compatible, so it drops into a GPL-2.0-only project (e.g.&nbsp;TinkerQuarry) unchanged.</p></div>
100-
<div class="card"><h3>✅ Tested &amp; CI</h3><p>Compile-time preset assertions, split fast/heavy suites, a PowerShell render-proof, and GitHub Actions rendering on every push.</p></div>
100+
<div class="card"><h3>✅ Tested &amp; CI</h3><p>Compile-time preset assertions, split render cells, negative/assert tests, independent STL mesh checks, and GitHub Actions running the same proof on every push.</p></div>
101101
</div>
102102
</div>
103103
</section>

0 commit comments

Comments
 (0)