yapCAD 0.5.0__tar.gz → 0.5.1__tar.gz

yapcad-0.5.1/.github/workflows/python-package.yml

@@ -0,0 +1,42 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python package
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install OpenGL (GLU)
+      run: sudo apt-get update && sudo apt-get install -y libglu1-mesa libglu1-mesa-dev
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install flake8 pytest pytest-cov
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        VISUALTEST=false PYTHONPATH=${PWD}/src:$PYTHONPATH pytest tests/ -m "not visual"

{yapcad-0.5.0 → yapcad-0.5.1}/.gitignore

@@ -54,5 +54,23 @@ v_*/
 #cached python version for pyenv
 .python-version
 
-# generated DXF files in examples
-examples/*.dxf
+
+
+# generated DXF files
+*.dxf
+# but include documentation DXF files
+!docs/*.dxf
+
+# generated stl files
+*.stl
+# but include documentation stl files
+!docs/*.stl
+
+# generated step files
+*.step
+# but include documentation step files
+!docs/*.step
+
+# ignore test python scripts in root
+/*.py
+

{yapcad-0.5.0 → yapcad-0.5.1}/CHANGELOG.rst

@@ -2,6 +2,51 @@
 Changelog
 =========
 
+Version 0.5.1 (2025-10-14)
+==========================
+
+what's new:
+-----------
+
+  - **3D Boolean Operations Fixes**: Complete overhaul of solid boolean operations
+    with robust normal orientation and interior triangle filtering.
+
+    - Fixed sphere union normal orientation issues by filtering interior overlap triangles
+    - Added quality-based filtering for degenerate sliver triangles (aspect ratio checks)
+    - Implemented containment-based filtering to remove artifacts in overlap regions
+    - All primitive tests now pass with correct watertight geometry
+
+  - **2D Boolean Operations Fixes**: Resolved crash when performing boolean operations
+    on ``Circle`` and other single-geometry primitives.
+
+    - Fixed geometry wrapping in ``Boolean._prepare_geom()`` to handle unwrapped arc format
+    - Added comprehensive regression tests for 2D boolean operations
+
+  - **Primitive Improvements**: Enhanced reliability of 3D geometric primitives.
+
+    - Fixed ``conic()`` primitive to generate proper watertight solids
+    - Fixed ``tube()`` primitive normal orientation and end cap connectivity
+    - All 9 core primitives (box, sphere, cylinder, cone, tube, etc.) validated as watertight
+
+  - **Modular Boolean Engine Architecture**: Separated boolean operations into
+    ``yapcad.boolean.native`` module for better maintainability.
+
+    - Support for multiple boolean engine backends (native, trimesh:manifold, trimesh:blender)
+    - Engine selection via ``solid_boolean(..., engine='native')`` parameter
+    - Environment variable support (``YAPCAD_BOOLEAN_ENGINE``, ``YAPCAD_TRIMESH_BACKEND``)
+
+  - **Test Suite Improvements**: Enhanced test coverage and reliability.
+
+    - 106 tests passing (up from 99 in v0.5.0)
+    - Added boolean regression test suite
+    - Improved solid topology tests with better error reporting
+
+Known problems
+--------------
+
+- Incomplete documentation for some advanced 3D features.
+- STEP export currently supports tessellated geometry; analytical BREP support planned for 1.0.
+
 Version 0.5.0 (2024-09-30)
 ==========================
 

{yapcad-0.5.0 → yapcad-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yapCAD
-Version: 0.5.0
+Version: 0.5.1
 Summary: yet another procedural CAD and computational geometry system
 Author-email: Richard DeVaul <richard.devaul@gmail.com>
 Project-URL: Homepage, https://github.com/rdevaul/yapCAD/
@@ -24,6 +24,9 @@ Requires-Dist: pyobjc-framework-Quartz; platform_system == "Darwin"
 Provides-Extra: tests
 Requires-Dist: pytest; extra == "tests"
 Requires-Dist: pytest-cov; extra == "tests"
+Provides-Extra: meshcheck
+Requires-Dist: trimesh>=4.0; extra == "meshcheck"
+Requires-Dist: pymeshfix>=0.16; extra == "meshcheck"
 Dynamic: license-file
 
 **yapCAD**
@@ -37,6 +40,24 @@ python 3, now with a growing focus on 3D generative design and STL export
 
    **yapCAD** rocket example
 
+.. note::
+
+   The 3D rocket demo above was produced in a single shot by
+   ``gpt-5-codex`` from the prompt::
+
+      Using what you know about yapCAD, I'd like you to create a demo that
+      builds a simple 3D model of a rocket, visualizes it using pyglet, and
+      then writes out the STL file. I'd like the rocket to have a cluster of
+      five engines, guidance fins, a cylindrical body with at least one
+      diameter transition before the payload fairing, and an aerodynamic
+      fairing. Can you do this for me?
+
+.. figure:: images/RocketCutawaySTEP.png
+   :alt: **yapCAD** rocket cutaway STEP export
+
+   Internal layout generated with ``examples/rocket_cutaway_internal.py`` and
+   rendered from the exported STEP file in FreeCAD.
+
 what’s **yapCAD** for?
 ----------------------
 
@@ -52,10 +73,14 @@ geometry experiments.
 software status
 ---------------
 
-**yapCAD** is still very much in **beta**, although it is already being
-used by for professional engineering purposes. If you are using
-**yapCAD** in interesting ways, feel free to let us know in the `yapCAD
-discussions <https://github.com/rdevaul/yapCAD/discussions>`__ forum
+**yapCAD** is in **active development** and is already being used for
+professional engineering purposes. Recent improvements include robust 3D
+boolean operations (union, intersection, difference) with proper normal
+orientation and degenerate triangle filtering. The 0.5.x series focuses on
+production-ready 3D workflows with validated STL and STEP export.
+
+If you are using **yapCAD** in interesting ways, feel free to let us know in the
+`yapCAD discussions <https://github.com/rdevaul/yapCAD/discussions>`__ forum
 
 **yapCAD** installation, documentation, and examples
 ----------------------------------------------------
@@ -89,8 +114,10 @@ PYTHONPATH includes the cloned top-level ``yapCAD`` directory. You will
 find the examples in the ``yapCAD/examples`` directory.
 
 For a fully worked 2D parametric design system, see the ``boxcut`` example.
-For a 3D generative example that builds a multi-stage rocket, visualises
-it, and exports STL, see ``examples/rocket_demo.py``.
+For a 3D generative example that builds a multi-stage rocket, visualises it,
+and exports STL, see ``examples/rocket_demo.py``. To explore the new stacking
+and cutaway helpers while exporting STEP, run
+``examples/rocket_cutaway_internal.py`` whose output is shown above.
 
 documentation
 ~~~~~~~~~~~~~
@@ -99,7 +126,18 @@ Online **yapCAD** documentation can be found here:
 https://yapcad.readthedocs.io/en/latest/ — some module references lag
 behind the latest 3D-focused APIs, so you may want to build a local copy
 as described below to explore ``geometry_utils``, ``geometry_checks``,
-``metadata``, and ``io.stl``.
+``metadata``, and the ``yapcad.io`` exporters. Highlights from the most
+recent updates include:
+
+* ``yapcad.geometry_utils`` and ``yapcad.triangulator`` – triangle helpers
+  backing the ear-cut tessellator and faceted exporters.
+* ``yapcad.geom3d_util.stack_solids`` – quickly pack solids along an axis
+  using bounding boxes and optional ``space:<distance>`` directives.
+* ``yapcad.geom3d_util.cutaway_solid_x`` – trim solids against a plane to
+  create sectional visualisations.
+* ``yapcad.io.step``/``yapcad.io.stl`` – production-ready faceted exporters
+  suitable for interchange with FreeCAD, slicers, and other simulation tools.
+  STEP export supports multi-component assemblies with proper face orientation.
 
 To build the HTML **yapCAD** documentation locally, install the
 documentation dependencies and run Sphinx from the project root::
@@ -179,14 +217,18 @@ drawing file format. At present, **yapCAD** supports:
 
 * AutoCAD DXF output for two-dimensional drawings (via
   `ezdxf <https://github.com/mozman/ezdxf>`__).
-* STL export for 3D solids (via the new ``yapcad.io.stl`` module).
+* STL and STEP export for 3D solids (via ``yapcad.io.stl`` and
+  ``yapcad.io.step`` modules).
 * OpenGL visualisation for 2D/3D geometries using
   `pyglet <https://github.com/pyglet/pyglet>`__.
+* Modular 3D boolean operations supporting both native and external engines
+  (trimesh with Manifold/Blender backends).
 
-The 0.5.0 release lays the shared foundations (triangle utilities,
-metadata, validation checks, and STL export) that pave the way toward STEP
-support and a packaged, provenance-aware project model targeted for the
-forthcoming 1.0 release.
+The 0.5.x series delivers robust 3D boolean operations, validated primitive
+generation (sphere, cylinder, cone, tube, etc.), comprehensive mesh validation
+tools, and production-ready export capabilities. These foundations pave the way
+toward enhanced STEP support and a packaged, provenance-aware project model
+targeted for the forthcoming 1.0 release.
 
 The foundations of **yapCAD** are grounded in decades of the author’s
 experience with graphics system programming, 3D CAD and simulation.
@@ -242,13 +284,17 @@ is a DXF example:
    dd.display()
 
 For a 3D example that generates a complete rocket assembly and exports
-STL::
+STL and STEP::
 
    from pathlib import Path
    from examples.rocket_demo import build_rocket, export_stl
+   from yapcad.io.step import write_step
 
    components, assembly = build_rocket()
    export_stl(assembly, Path("rocket_demo.stl"))
+   write_step(assembly, Path("rocket_demo.step"))
+
+There is also an advanced ``rocket_grid_demo.py`` example featuring grid fins, a linear exploded view, and simultaneous STL/STEP export.
 
 The **yapCAD** system isn’t just about rendering, of course, it’s about
 computational geometry. For example, if you want to calculate the

{yapcad-0.5.0 → yapcad-0.5.1}/README.md

@@ -18,9 +18,13 @@ design.
 
 ## software status
 
-**yapCAD** is still very much in **beta**, although it is already being
-used by for professional engineering purposes.  If you are using
-**yapCAD** in interesting ways, feel free to let us know in the
+**yapCAD** is in **active development** and is already being used for
+professional engineering purposes. Recent improvements include robust 3D
+boolean operations (union, intersection, difference) with proper normal
+orientation and degenerate triangle filtering. The 0.5.x series focuses on
+production-ready 3D workflows with validated STL and STEP export.
+
+If you are using **yapCAD** in interesting ways, feel free to let us know in the
 [**yapCAD** discussions](https://github.com/rdevaul/yapCAD/discussions)
 forum
 
@@ -47,9 +51,19 @@ examples, clone the github repository as shown above, and make sure
 that your PYTHONPATH includes the cloned top-level `yapCAD` directory.
 You will find the examples in the `yapCAD/examples` directory.
 
-For a fully worked 2D parametric design system, see the `boxcut`
-example.  For a 3D generative example that builds a multi-stage rocket,
-visualises it, and exports STL, see `examples/rocket_demo.py`.
+For a fully worked 2D parametric design system, see the `boxcut` example. For a
+3D generative example that builds a multi-stage rocket, visualises it, and
+exports STL, see `examples/rocket_demo.py`. **NOTE** The 3D rocket example code
+was generated in one shot by `gpt-5-codex` from the following prompt:
+
+    Using what you know about yapCAD, I'd like you to create a demo that builds a simple 3D model of a rocket, visualizes it using pyglet, and then writes out the STL file. I'd like the rocket to have a cluster of five engines, guidance fins, a cylindrical body with at least one diameter transition before the payload fairing, and an aerodynamic fairing. Can you do this for me?
+
+![**yapCAD** rocket cutaway STEP export](images/RocketCutawaySTEP.png)
+
+To see how the newer helper utilities can be combined to lay out internal
+subsystems and export STEP, try `examples/rocket_cutaway_internal.py` — the
+screenshot above shows its STEP output rendered in FreeCAD.
+
 
 ### documentation
 
@@ -57,7 +71,22 @@ Online **yapCAD** documentation can be found here:
 https://yapcad.readthedocs.io/en/latest/ — some module references
 lag behind the current 3D-focused APIs, so you may want to build a
 local copy (see below) to explore the latest `geometry_utils`,
-`metadata`, `geometry_checks`, and `io.stl` modules.
+`geometry_checks`, `metadata`, and `io` modules. Recent additions worth
+calling out include:
+
+- `yapcad.geometry_utils` & `yapcad.triangulator` – robust triangle
+  utilities used by the ear-cut tessellator and STEP exporter.
+- `yapcad.geom3d_util.stack_solids` – a convenience routine that packs
+  solids along an axis using bounding boxes and optional spacing
+  directives (used by the rocket cutaway demo).
+- `yapcad.geom3d_util.cutaway_solid_x` – simple clipping helper for
+  creating sectional views of assemblies.
+- `yapcad.io.step`/`yapcad.io.stl` – production-ready faceted exporters suitable for
+  interchange with FreeCAD, slicers, and other simulation tools. STEP export supports
+  multi-component assemblies with proper face orientation.
+- `tools/validate_mesh.py` – CLI helper that runs `admesh`, `meshfix`, and an
+  optional slicer to gauge whether STL output is robust enough for CAM; see
+  `docs/mesh_validation.md` for usage.
 
 To build the HTML **yapCAD** documentation locally, install the
 documentation dependencies and run Sphinx from the project root:
@@ -142,14 +171,17 @@ add support for a cad or drawing file format.  At present,
 
 - AutoCAD DXF output for two-dimensional drawings (via
   [ezdxf](https://github.com/mozman/ezdxf)).
-- STL export for 3D solids (via the new `yapcad.io.stl` module).
+- STL and STEP export for 3D solids (via `yapcad.io.stl` and `yapcad.io.step` modules).
 - OpenGL visualisation for 2D/3D geometries using
   [pyglet](https://github.com/pyglet/pyglet).
+- Modular 3D boolean operations supporting both native and external engines
+  (trimesh with Manifold/Blender backends).
 
-The 0.5.0 release lays the shared foundations (triangle utilities,
-metadata, validation checks, and STL export) that pave the way toward
-STEP support and a packaged, provenance-aware project model targeted for
-the forthcoming 1.0 release.
+The 0.5.x series delivers robust 3D boolean operations, validated primitive
+generation (sphere, cylinder, cone, tube, etc.), comprehensive mesh validation
+tools, and production-ready export capabilities. These foundations pave the way
+toward enhanced STEP support and a packaged, provenance-aware project model
+targeted for the forthcoming 1.0 release.
 
 The foundations of **yapCAD** are grounded in decades of the author's
 experience with graphics system programming, 3D CAD and
@@ -202,16 +234,21 @@ is a DXF example:
     # write out the geometry as example1-out.dxf
     dd.display()
 
-For a 3D example that generates a complete rocket assembly and exports STL:
+For a 3D example that generates a complete rocket assembly and exports STL and STEP:
 
 ```python
 from pathlib import Path
 from examples.rocket_demo import build_rocket, export_stl
+from yapcad.io.step import write_step
 
 components, assembly = build_rocket()
 export_stl(assembly, Path("rocket_demo.stl"))
+write_step(assembly, Path("rocket_demo.step"))
 ```
 
+There is also an advanced `rocket_grid_demo.py` example featuring grid fins,
+a linear exploded view, and simultaneous STL/STEP export.
+
 The **yapCAD** system isn't just about rendering, of course, it's
 about computational geometry.  For example, if you want to calculate
 the intersection of lines and arcs in a plane, we have you covered:

{yapcad-0.5.0 → yapcad-0.5.1}/README.rst

@@ -9,6 +9,24 @@ python 3, now with a growing focus on 3D generative design and STL export
 
    **yapCAD** rocket example
 
+.. note::
+
+   The 3D rocket demo above was produced in a single shot by
+   ``gpt-5-codex`` from the prompt::
+
+      Using what you know about yapCAD, I'd like you to create a demo that
+      builds a simple 3D model of a rocket, visualizes it using pyglet, and
+      then writes out the STL file. I'd like the rocket to have a cluster of
+      five engines, guidance fins, a cylindrical body with at least one
+      diameter transition before the payload fairing, and an aerodynamic
+      fairing. Can you do this for me?
+
+.. figure:: images/RocketCutawaySTEP.png
+   :alt: **yapCAD** rocket cutaway STEP export
+
+   Internal layout generated with ``examples/rocket_cutaway_internal.py`` and
+   rendered from the exported STEP file in FreeCAD.
+
 what’s **yapCAD** for?
 ----------------------
 
@@ -24,10 +42,14 @@ geometry experiments.
 software status
 ---------------
 
-**yapCAD** is still very much in **beta**, although it is already being
-used by for professional engineering purposes. If you are using
-**yapCAD** in interesting ways, feel free to let us know in the `yapCAD
-discussions <https://github.com/rdevaul/yapCAD/discussions>`__ forum
+**yapCAD** is in **active development** and is already being used for
+professional engineering purposes. Recent improvements include robust 3D
+boolean operations (union, intersection, difference) with proper normal
+orientation and degenerate triangle filtering. The 0.5.x series focuses on
+production-ready 3D workflows with validated STL and STEP export.
+
+If you are using **yapCAD** in interesting ways, feel free to let us know in the
+`yapCAD discussions <https://github.com/rdevaul/yapCAD/discussions>`__ forum
 
 **yapCAD** installation, documentation, and examples
 ----------------------------------------------------
@@ -61,8 +83,10 @@ PYTHONPATH includes the cloned top-level ``yapCAD`` directory. You will
 find the examples in the ``yapCAD/examples`` directory.
 
 For a fully worked 2D parametric design system, see the ``boxcut`` example.
-For a 3D generative example that builds a multi-stage rocket, visualises
-it, and exports STL, see ``examples/rocket_demo.py``.
+For a 3D generative example that builds a multi-stage rocket, visualises it,
+and exports STL, see ``examples/rocket_demo.py``. To explore the new stacking
+and cutaway helpers while exporting STEP, run
+``examples/rocket_cutaway_internal.py`` whose output is shown above.
 
 documentation
 ~~~~~~~~~~~~~
@@ -71,7 +95,18 @@ Online **yapCAD** documentation can be found here:
 https://yapcad.readthedocs.io/en/latest/ — some module references lag
 behind the latest 3D-focused APIs, so you may want to build a local copy
 as described below to explore ``geometry_utils``, ``geometry_checks``,
-``metadata``, and ``io.stl``.
+``metadata``, and the ``yapcad.io`` exporters. Highlights from the most
+recent updates include:
+
+* ``yapcad.geometry_utils`` and ``yapcad.triangulator`` – triangle helpers
+  backing the ear-cut tessellator and faceted exporters.
+* ``yapcad.geom3d_util.stack_solids`` – quickly pack solids along an axis
+  using bounding boxes and optional ``space:<distance>`` directives.
+* ``yapcad.geom3d_util.cutaway_solid_x`` – trim solids against a plane to
+  create sectional visualisations.
+* ``yapcad.io.step``/``yapcad.io.stl`` – production-ready faceted exporters
+  suitable for interchange with FreeCAD, slicers, and other simulation tools.
+  STEP export supports multi-component assemblies with proper face orientation.
 
 To build the HTML **yapCAD** documentation locally, install the
 documentation dependencies and run Sphinx from the project root::
@@ -151,14 +186,18 @@ drawing file format. At present, **yapCAD** supports:
 
 * AutoCAD DXF output for two-dimensional drawings (via
   `ezdxf <https://github.com/mozman/ezdxf>`__).
-* STL export for 3D solids (via the new ``yapcad.io.stl`` module).
+* STL and STEP export for 3D solids (via ``yapcad.io.stl`` and
+  ``yapcad.io.step`` modules).
 * OpenGL visualisation for 2D/3D geometries using
   `pyglet <https://github.com/pyglet/pyglet>`__.
+* Modular 3D boolean operations supporting both native and external engines
+  (trimesh with Manifold/Blender backends).
 
-The 0.5.0 release lays the shared foundations (triangle utilities,
-metadata, validation checks, and STL export) that pave the way toward STEP
-support and a packaged, provenance-aware project model targeted for the
-forthcoming 1.0 release.
+The 0.5.x series delivers robust 3D boolean operations, validated primitive
+generation (sphere, cylinder, cone, tube, etc.), comprehensive mesh validation
+tools, and production-ready export capabilities. These foundations pave the way
+toward enhanced STEP support and a packaged, provenance-aware project model
+targeted for the forthcoming 1.0 release.
 
 The foundations of **yapCAD** are grounded in decades of the author’s
 experience with graphics system programming, 3D CAD and simulation.
@@ -214,13 +253,17 @@ is a DXF example:
    dd.display()
 
 For a 3D example that generates a complete rocket assembly and exports
-STL::
+STL and STEP::
 
    from pathlib import Path
    from examples.rocket_demo import build_rocket, export_stl
+   from yapcad.io.step import write_step
 
    components, assembly = build_rocket()
    export_stl(assembly, Path("rocket_demo.stl"))
+   write_step(assembly, Path("rocket_demo.step"))
+
+There is also an advanced ``rocket_grid_demo.py`` example featuring grid fins, a linear exploded view, and simultaneous STL/STEP export.
 
 The **yapCAD** system isn’t just about rendering, of course, it’s about
 computational geometry. For example, if you want to calculate the

{yapcad-0.5.0 → yapcad-0.5.1}/docs/README.rst

@@ -9,6 +9,24 @@ python 3, now with a growing focus on 3D generative design and STL export
 
    **yapCAD** rocket example
 
+.. note::
+
+   The 3D rocket demo above was produced in a single shot by
+   ``gpt-5-codex`` from the prompt::
+
+      Using what you know about yapCAD, I'd like you to create a demo that
+      builds a simple 3D model of a rocket, visualizes it using pyglet, and
+      then writes out the STL file. I'd like the rocket to have a cluster of
+      five engines, guidance fins, a cylindrical body with at least one
+      diameter transition before the payload fairing, and an aerodynamic
+      fairing. Can you do this for me?
+
+.. figure:: images/RocketCutawaySTEP.png
+   :alt: **yapCAD** rocket cutaway STEP export
+
+   Internal layout generated with ``examples/rocket_cutaway_internal.py`` and
+   rendered from the exported STEP file in FreeCAD.
+
 what’s **yapCAD** for?
 ----------------------
 
@@ -24,10 +42,14 @@ geometry experiments.
 software status
 ---------------
 
-**yapCAD** is still very much in **beta**, although it is already being
-used by for professional engineering purposes. If you are using
-**yapCAD** in interesting ways, feel free to let us know in the `yapCAD
-discussions <https://github.com/rdevaul/yapCAD/discussions>`__ forum
+**yapCAD** is in **active development** and is already being used for
+professional engineering purposes. Recent improvements include robust 3D
+boolean operations (union, intersection, difference) with proper normal
+orientation and degenerate triangle filtering. The 0.5.x series focuses on
+production-ready 3D workflows with validated STL and STEP export.
+
+If you are using **yapCAD** in interesting ways, feel free to let us know in the
+`yapCAD discussions <https://github.com/rdevaul/yapCAD/discussions>`__ forum
 
 **yapCAD** installation, documentation, and examples
 ----------------------------------------------------
@@ -61,8 +83,10 @@ PYTHONPATH includes the cloned top-level ``yapCAD`` directory. You will
 find the examples in the ``yapCAD/examples`` directory.
 
 For a fully worked 2D parametric design system, see the ``boxcut`` example.
-For a 3D generative example that builds a multi-stage rocket, visualises
-it, and exports STL, see ``examples/rocket_demo.py``.
+For a 3D generative example that builds a multi-stage rocket, visualises it,
+and exports STL, see ``examples/rocket_demo.py``. To explore the new stacking
+and cutaway helpers while exporting STEP, run
+``examples/rocket_cutaway_internal.py`` whose output is shown above.
 
 documentation
 ~~~~~~~~~~~~~
@@ -71,7 +95,18 @@ Online **yapCAD** documentation can be found here:
 https://yapcad.readthedocs.io/en/latest/ — some module references lag
 behind the latest 3D-focused APIs, so you may want to build a local copy
 as described below to explore ``geometry_utils``, ``geometry_checks``,
-``metadata``, and ``io.stl``.
+``metadata``, and the ``yapcad.io`` exporters. Highlights from the most
+recent updates include:
+
+* ``yapcad.geometry_utils`` and ``yapcad.triangulator`` – triangle helpers
+  backing the ear-cut tessellator and faceted exporters.
+* ``yapcad.geom3d_util.stack_solids`` – quickly pack solids along an axis
+  using bounding boxes and optional ``space:<distance>`` directives.
+* ``yapcad.geom3d_util.cutaway_solid_x`` – trim solids against a plane to
+  create sectional visualisations.
+* ``yapcad.io.step``/``yapcad.io.stl`` – production-ready faceted exporters
+  suitable for interchange with FreeCAD, slicers, and other simulation tools.
+  STEP export supports multi-component assemblies with proper face orientation.
 
 To build the HTML **yapCAD** documentation locally, install the
 documentation dependencies and run Sphinx from the project root::
@@ -151,14 +186,18 @@ drawing file format. At present, **yapCAD** supports:
 
 * AutoCAD DXF output for two-dimensional drawings (via
   `ezdxf <https://github.com/mozman/ezdxf>`__).
-* STL export for 3D solids (via the new ``yapcad.io.stl`` module).
+* STL and STEP export for 3D solids (via ``yapcad.io.stl`` and
+  ``yapcad.io.step`` modules).
 * OpenGL visualisation for 2D/3D geometries using
   `pyglet <https://github.com/pyglet/pyglet>`__.
+* Modular 3D boolean operations supporting both native and external engines
+  (trimesh with Manifold/Blender backends).
 
-The 0.5.0 release lays the shared foundations (triangle utilities,
-metadata, validation checks, and STL export) that pave the way toward STEP
-support and a packaged, provenance-aware project model targeted for the
-forthcoming 1.0 release.
+The 0.5.x series delivers robust 3D boolean operations, validated primitive
+generation (sphere, cylinder, cone, tube, etc.), comprehensive mesh validation
+tools, and production-ready export capabilities. These foundations pave the way
+toward enhanced STEP support and a packaged, provenance-aware project model
+targeted for the forthcoming 1.0 release.
 
 The foundations of **yapCAD** are grounded in decades of the author’s
 experience with graphics system programming, 3D CAD and simulation.
@@ -214,13 +253,17 @@ is a DXF example:
    dd.display()
 
 For a 3D example that generates a complete rocket assembly and exports
-STL::
+STL and STEP::
 
    from pathlib import Path
    from examples.rocket_demo import build_rocket, export_stl
+   from yapcad.io.step import write_step
 
    components, assembly = build_rocket()
    export_stl(assembly, Path("rocket_demo.stl"))
+   write_step(assembly, Path("rocket_demo.step"))
+
+There is also an advanced ``rocket_grid_demo.py`` example featuring grid fins, a linear exploded view, and simultaneous STL/STEP export.
 
 The **yapCAD** system isn’t just about rendering, of course, it’s about
 computational geometry. For example, if you want to calculate the