diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 95% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md index 14d2186..0004cd3 100644 --- a/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# How to contribute to threadlib +# How to contribute Thank for considering a contribution to threadlib! Any help is greatly appreciated. @@ -53,10 +53,10 @@ That's what we need the most! This is how to do it: * Find help on this topic in [Design of threadlib](docs/DesignOfThreadlib.md) and [Creating Thread Specs](docs/CreatingThreadSpecs.md) - * Use existing threads as examples. You find them beneath design/ + * Use existing threads as examples. You find them in design/ * When done, proceed with a pull request (see "Did you write a patch?" above) - + ## Final remarks diff --git a/docs/README.rst b/docs/README.rst index 0b53cb9..76cf015 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -1,4 +1,4 @@ -.. image:: docs/imgs/logo.png +.. image:: imgs/logo.png :alt: bolt-in-nut logo threadlib is a library of standard threads for `OpenSCAD `__. @@ -21,7 +21,7 @@ Creating a thread is as simple as use thread("G1/2-ext", turns=10); -.. image:: docs/imgs/thread-G1o2-ext-10turns.png +.. image:: imgs/thread-G1o2-ext-10turns.png :alt: bolt-in-nut logo to create a British Standard Pipe parallel external thread. @@ -83,7 +83,7 @@ To create a bolt (without head) with 5 turns of M4 thread: bolt("M4", turns=5, higbee_arc=30); -.. image:: docs/imgs/bolt-M4.png +.. image:: imgs/bolt-M4.png :alt: Bolt with M4 thread See these nice lead-in / lead-out tapers? Try a nut (this time using the default @@ -93,7 +93,7 @@ argument for higbee_arc): nut("M12x0.5", turns=10, Douter=16); -.. image:: docs/imgs/nut-M12x0.5.png +.. image:: imgs/nut-M12x0.5.png :alt: M12x0.5 nut Note that for a nut you also have to specify an outer diameter. The inner @@ -108,7 +108,7 @@ threadlib's solution is to provide the tap module: tap("G1/2", turns=5); -.. image:: docs/imgs/tap-G1o2.png +.. image:: imgs/tap-G1o2.png :alt: G1/2 tap The tap shown above *is* intended for use like this and has accounted for the @@ -131,7 +131,7 @@ If you only need the threads alone: thread("G1/2-ext", turns=5); -.. image:: docs/imgs/thread-G1o2-ext.png +.. image:: imgs/thread-G1o2-ext.png :alt: G1/2 external thread (Note: You need to specify whether you want internal ("-int") or external @@ -147,7 +147,7 @@ case, a cylinder (which is what nut(...) uses): translate([0, 0, -P / 2]) cylinder(h=H, d=Dsupport, $fn=120); -.. image:: docs/imgs/flexible.png +.. image:: imgs/flexible.png :alt: G1/2 bolt Here, we have used the function thread_specs(...) to look up the threads @@ -190,11 +190,9 @@ add your own: thread("special", turns=15, table=MY_THREAD_TABLE); Care to share? Safe others from repeating the valuable work you have already -accomplished and get the fame you deserve: Send in your tried and tested threads -for addition to threadlib! See `Design of Threadlib <./docs/DesignOfThreadlib.md>`_ -for help on how to hack your own thread as shown above and -`Creating Thread Specs <./docs/CreatingThreadSpecs.md>`_ for an introduction on how -to contribute entire thread classes to threadlib. +accomplished and get the fame you deserve: Send in your tried and tested +threads for addition to threadlib! See `How to contribute <./CONTRIBUTING.md>`_ +for help on how to become a contributor. Still reading?