17 Commits

Author SHA1 Message Date
Adrian Schlatter
0b785b7b4f re-org docs/ 2023-04-02 16:02:01 +02:00
Adrian Schlatter
ad42e03241 Release.md
What I should not forget when creating a release
2022-12-08 22:13:17 +01:00
Adrian Schlatter
d8c8384988 ThreadProfile.png
Improved illustration of thread-profile spec by showing
Rsup and Rrot in ThreadProfile.png.
2021-10-10 16:16:00 +02:00
Adrian Schlatter
4bb8c70987
Development Docs (#58)
Improved development docs and link to it from README.
2021-10-09 15:26:08 +02:00
Adrian Schlatter
bb860b61a2
Fix docs (#44)
Docs

* Fixed broken links (to mdmetrics.com) in docs/* and README.rst
* Removed externally rendered formula (broken link) in BSPPthread.md
* Added explanation for tap module to README.rst
  which also required a new image and a line in the docs/Makefile

CONTRIBUTING

* Added CONTRIBUTING (closes #3)
2020-08-04 22:36:37 +02:00
Adrian Schlatter
55e360d76b
Unified Inch Screw Threads (#29)
Unified Inch Screw Threads
++++++++++++++++++++++++++

Added unified inch screw threads. Namely UNC, UNF, UNEF, 4-UN, 6-UN,
8-UN, 12-UN, 16-UN, 20-UN, 28-UN, and 32-UN.

Also, removed reference to long-gone Excel table.

solves #11 
solves #12 
solves #13
2019-11-11 21:20:33 +01:00
Adrian Schlatter
7e30d8e824
Add tech-docs for metric thread (#23)
Describes the choices made when deriving threadlib specs from the metric
thread norms.

closes #7
2019-05-26 19:00:07 +02:00
Adrian Schlatter
ad12ec4961
Tech docs bspp (#21)
Tech-docs BSP-Parallel thread

- Documented how threadlike specs for BSPP thread are derived from norm data. 
- Refactoring of BSPP_thread.awk to make the code easier to document (order of calculations, avoid repetition).

closes #6
2019-05-08 22:08:33 +02:00
Adrian Schlatter
26ad35c72a Add developer docs
- explain structure of THREAD_TABLE.scad and relation to thread module
- explain threads and how to derive proper specs for inclusion in threadlib
- explain use of autogenerate.awk
- explain tests (i.e., test_table.awk)

closes #5
2019-04-30 21:45:02 +02:00
Adrian Schlatter
7dd62dd0a7 Fix doc problems 2019-04-13 18:56:55 +02:00
Adrian Schlatter
87e6182d6c - README.rst: nice images
- .gitignore
2019-04-13 17:41:06 +02:00
Adrian Schlatter
0251ea7d62 Closing in ... 2019-04-13 15:14:02 +02:00
Adrian Schlatter
300c3c901f Further test getting a decent logo/title. 2019-04-13 14:59:41 +02:00
Adrian Schlatter
acfdd608e3 make it *even* smaller. Trying to get around github/markup#295 2019-04-13 14:47:09 +02:00
Adrian Schlatter
99165bca86 nutNbolt.png smaller (fitting GitHub?) 2019-04-13 14:36:46 +02:00
Adrian Schlatter
8dba11fe77 fixing missing images in README.rst 2019-04-10 22:17:35 +02:00
Adrian Schlatter
beee1f1921 - dir structure (docs, tests, design)
- renderings for README.rst
2019-04-10 21:55:13 +02:00