@@ -232,6 +232,8 @@ Use `-DSD_WITH_<LIB>=ON/OFF` CMake options (see `CMakeLists.txt`) to toggle modu
232232
233233## Getting Started
234234
235+ A typical workflow target (end state):
236+
2352371 . ** Create a project** and set default units/tolerances.
2362382 . ** Sketch** on a plane; use constraints/dimensions.
2372393 . Create features: ** Extrude** , ** Revolve** , ** Fillet** , ** Shell** , ** Pattern** …
@@ -255,10 +257,22 @@ Use `-DSD_WITH_<LIB>=ON/OFF` CMake options (see `CMakeLists.txt`) to toggle modu
255257
256258## Data & File Formats
257259
258- - ** Native Project** : a structured, versioned project format (TBD; JSON + binary payloads or similar).
259- - ** CAD Interop** : STEP/IGES import/export (others as available through adapters).
260- - ** Mesh/Results** : standard mesh/results formats for external solvers/post (VTK, MED, etc., planned).
261- - ** Units** : consistent unit system with explicit metadata; dimensioned parameters in expressions.
260+ ### Native project format (in progress)
261+
262+ The native format is intended to be:
263+
264+ - ** Structured** : metadata + typed payloads (geometry, mesh, results, thumbnails, etc.)
265+ - ** Versioned** : schema versioning with explicit upgrade pipeline
266+ - ** Incremental-friendly** : designed for partial reload and future cloud/workspace workflows
267+ - ** Stable-identity aware** : object IDs survive save/load, copy/paste, and upgrades
268+
269+ > The public wiki will host the canonical specification once the format stabilizes.
270+
271+ ### Interoperability (planned / incremental)
272+
273+ - ** CAD Interop** : STEP/IGES import/export (others via adapters)
274+ - ** Mesh/Results** : standard mesh/results formats for external solvers/post (VTK, MED, etc., planned)
275+ - ** Units** : consistent unit system with explicit metadata; dimensioned parameters in expressions
262276
263277---
264278
@@ -273,21 +287,28 @@ Use `-DSD_WITH_<LIB>=ON/OFF` CMake options (see `CMakeLists.txt`) to toggle modu
273287
274288## Contributing
275289
276- Contributions are welcome!
290+ Contributions are welcome.
291+
292+ - Review JIRA epics/tasks and the GitHub Wiki for context.
293+ - Discuss larger proposals before opening a PR.
294+ - Follow the project’s code style (clang-format file planned) and include unit tests.
295+ - Keep commits small and well-described; link to JIRA tickets where applicable.
277296
278- - Review open issues on ** JIRA** and the ** GitHub Wiki** for context.
279- - Discuss larger proposals in issues or on the wiki before opening a PR.
280- - Follow the project’s ** code style** (clang‑format file incoming) and include ** unit tests** .
281- - Keep commits small and well‑described; link to JIRA tickets where applicable.
297+ Suggested first contributions:
282298
283- > Please see ` CONTRIBUTING.md ` (to be added) and ` CODE_OF_CONDUCT.md ` (to be added).
299+ - Fix build issues on a specific platform/compiler
300+ - Add focused tests (geometry, persistence, constraint solving)
301+ - Add documentation: design notes, diagrams, or minimal “how it works” sections
302+
303+ > Repository-level contributor docs (planned): ` CONTRIBUTING.md ` , ` CODE_OF_CONDUCT.md ` .
284304
285305---
286306
287307## License
288308
289- Open‑source license (GNU General Public License v3.0).
290- The final license will be published in ` LICENSE ` . Until then, assume ** source is for evaluation and development only** .
309+ This repository is licensed under ** GNU GPL v3.0** . See ` LICENSE ` for the full text.
310+
311+ > Note: third‑party libraries may have their own licenses; ensure compliance when redistributing binaries.
291312
292313---
293314
@@ -301,7 +322,7 @@ Special thanks to contributors and researchers in CAD/CAE/CFD/optimization.
301322## FAQ
302323
303324** How close is this to production tools like Creo?**
304- The aspiration is parity for core workflows with a modern, open architecture. Today the project is pre‑alpha; many features are WIP.
325+ The aspiration is parity for core workflows with a modern, open architecture. Today the project is pre‑alpha; many capabilities are WIP.
305326
306327** Is there a scripting API?**
307328A Python API is planned. Early internal scaffolding exists; public API is forthcoming.
@@ -310,7 +331,7 @@ A Python API is planned. Early internal scaffolding exists; public API is forthc
310331Early in‑house solvers are being prototyped. Adapters to external solvers (e.g., meshers/post) are planned.
311332
312333** Will AI features require internet access?**
313- No. The intent is to support ** offline** inference with local models, with optional cloud integrations.
334+ No. The intent is to support offline inference with local models, with optional cloud integrations.
314335
315336** Where can I track progress?**
316337JIRA (roadmap/backlog) and the public GitHub wiki. Detailed design docs are in Confluence (access required).
0 commit comments