From 444090d4820bbc8863b429f39dcbc32ab4e86856 Mon Sep 17 00:00:00 2001 From: mahach666 <79989386+mahach666@users.noreply.github.com> Date: Thu, 12 Nov 2026 13:26:54 +0300 Subject: [PATCH] Document which extras are frozen --- .github/dependabot.yml | 10 ++++++++++ CHANGELOG.md | 1 + README.md | 11 +++++++++++ 3 files changed, 22 insertions(+) create mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..a846233 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,10 @@ +version: 2 +updates: + - package-ecosystem: nuget + directory: / + schedule: + interval: weekly + - package-ecosystem: github-actions + directory: / + schedule: + interval: weekly diff --git a/CHANGELOG.md b/CHANGELOG.md index 11e60ac..92dacd1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,6 +21,7 @@ All notable changes to the `IfcIO` library are documented in this file. - `IfcElement.Solid`, `RevolvedSolid` and `BooleanResult` of read elements still describe the first body item in its own coordinates (only the `Mesh` is world-placed). Writing a read model back therefore still places those solids without the element placement, as before. - Malformed placement data (a `PlacementRelTo` cycle, an `IfcMappedItem` cycle or mapping nested deeper than 64 levels) makes `IfcModel.Open` throw `InvalidDataException`. So does geometry that expands to more than 1,000,000 + 256 vertices per STEP entity, which guards against nested `IfcMappedItem` amplification. - For length units without an `IfcLengthUnit` value, only geometry and storey elevations are converted to metres; quantities and property values stay in file units. Such elements get no `Solid` / `RevolvedSolid` / `BooleanResult` (those would stay in file units), so saving writes the metre `Mesh`. +- **Documentation**: the README lists the frozen extras (HTML viewer, GLB/OBJ export, clash, measure, grids, diff, BCF), which get bug fixes only, and their planned replacements. ## [0.10.0] - 2026-11-11 diff --git a/README.md b/README.md index 9e0f49b..f46e5b3 100644 --- a/README.md +++ b/README.md @@ -144,6 +144,17 @@ Reads and writes ISO 10303-21 STEP physical files conforming to **IFC2x3 Coordin - IFC5 (USD/JSON) is not yet supported. - Boolean mesh cutting evaluates planar CSG half-spaces; non-planar curved intersections are tessellated. +## Scope and frozen features + +IfcIO reads and writes IFC. The following extras are frozen: they get bug fixes only, no new features or options. + +- HTML viewer (`IfcHtmlViewerExporter`, `ifcio view`). Viewing will move to [IOViewer](https://github.com/IOExtend/IOViewer) through a planned `IfcIO.Scene` adapter over the shared, planned `IOScene` model. +- GLB and OBJ export (`IfcGlbExporter`, `IfcObjExporter`). A shared GLB writer is planned in `IOScene.Formats`. +- Clash detection, measure, grids, diff, and BCF archives (`IfcClashDetector`, `IfcClashGrouper`, `IfcMeasureEngine`, `IfcGridSystem`, `IfcDiffEngine`, `BcfArchive`, `BcfZipExporter`). These will move to a planned `IOCoord` package. +- IFC work-schedule (4D) sequence logic. It stays in IfcIO. + +None of these packages is published yet. The frozen features stay available and are removed no earlier than IfcIO 1.0, and only after a published replacement exists. + ## Build from source and tests Use the .NET SDK selected by `global.json`, which specifies 10.0.100 with `latestFeature` roll-forward.