From c6331f3525abfc1e4882b79b9cef94849b58e4b8 Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Wed, 21 Feb 2024 12:38:22 +0100 Subject: [PATCH] Update `About` section in README --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6084ea4f8c..76e26f28ce 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,20 @@ ## About -Fornjot is an early-stage [b-rep](https://en.wikipedia.org/wiki/Boundary_representation) CAD kernel written in the Rust programming language. +Fornjot is an **early-stage CAD kernel**, using **boundary representation (b-rep)**, written in the Rust programming language. -For an introduction of what the project aims to achieve, [please check out the website](https://www.fornjot.app/). +As a CAD kernel, the project's main goal is to provide **a solid foundation for developers to build on top of**, whether for special purpose tooling, third-party libraries for extending Fornjot's feature set, or full-featured CAD applications. + +In doing so, Fornjot follows these principles: + +- Focus on **mechanical CAD applications**, like 3D printing, machining, woodworking; over other CAD use cases like architecture or electronics. +- Favor **reliability over features**. Anything you can do should either work as expected, or result in a clear and actionable error. +- Maintain **a friendly API for directly defining models** in Rust. This means code-first CAD modeling (or Code-CAD) is natively supported. +- Support **code-first CAD modeling in other languages**, by enabling third-party APIs. + +Fornjot is still in development and doesn't always live up to these ambitions. None the less, these are the priorities the project follows. + +For more information, [please check out the website](https://www.fornjot.app/). ## Sponsors