From 0126245012b060339fd16ffd59e6f8dbddd67e43 Mon Sep 17 00:00:00 2001 From: Chris Palmer Date: Wed, 12 Jun 2019 11:44:59 +0100 Subject: [PATCH] Documentation typos --- docs/usage.md | 6 +++--- readme.md | 2 +- scripts/tests.py | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/usage.md b/docs/usage.md index b8fa46d..cd55143 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -69,14 +69,14 @@ if($preview) ``` -Other scad files can be added in the scad directory and included or used as reqired. +Other scad files can be added in the scad directory and included or used as required. * Subassemblies can be added in the same format as ```main_assembly()```, i.e. a module called ```something_assembly()```, taking no parameters and calling ```assembly("something")``` with the rest of its contents passed as children. Assembly instructions should be added directly before the module definition. * Any printed parts should be made by a module called ```something_stl()```, taking no parameters and calling ```stl("something")``` so they appear on the BOM. -* Any routed parts should be made by a module called ```something_dxf()```, taking no paraneters and calling ```dxf("something")``` so they appear on the BOM. +* Any routed parts should be made by a module called ```something_dxf()```, taking no parameters and calling ```dxf("something")``` so they appear on the BOM. When ```make_all``` is run from the top level directory of the project it will create the following sub-directories and populate them:- @@ -91,7 +91,7 @@ When ```make_all``` is run from the top level directory of the project it will c It will also make a Markdown assembly manual called ```readme.md``` suitable for GitHub, a version rendered to HTML for viewing locally called ```readme.html``` and a second HTML version called ```printme.html```. This has page breaks instead of horizontal rules and can be converted to PDF using Chrome to make a stand alone manual. -Each time OpenSCAD is run to produce STL, DXF or assembly views the time it takes is recorded and compared with the previous time. At the end the times are printed with the delta +Each time OpenSCAD is run to produce STL files, DXF files or assembly views the time it takes is recorded and compared with the previous time. At the end the times are printed with the delta from the last run and coloured red or green if they have got significantly faster or slower. This is useful for optimising the scad code for speed. When PNG files are made they are compared with the previous version and only updated if they have changed. When that happens a PNG difference file is created, so you can diff --git a/readme.md b/readme.md index adc6b66..73f9abf 100644 --- a/readme.md +++ b/readme.md @@ -10,7 +10,7 @@ For more examples of what it can make see the [gallery](gallery/readme.md). The license is GNU General Public License v3.0, see [COPYING](COPYING). -See [usage](docs/usage.md) for requirement, installation instructions and usage. +See [usage](docs/usage.md) for requirements, installation instructions and a usage guide. diff --git a/scripts/tests.py b/scripts/tests.py index 200bbe5..a89bb3f 100644 --- a/scripts/tests.py +++ b/scripts/tests.py @@ -239,7 +239,7 @@ For more examples of what it can make see the [gallery](gallery/readme.md). The license is GNU General Public License v3.0, see [COPYING](COPYING). -See [usage](docs/usage.md) for requirements, installation instructions and usage guide. +See [usage](docs/usage.md) for requirements, installation instructions and a usage guide. \n ''', file = doc_file)