From 5749807ee39b05e4112e623a707df31240ff8927 Mon Sep 17 00:00:00 2001 From: xiange Date: Sat, 9 Dec 2023 14:16:25 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=83=20docs:=20update=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index beb22b57..076ecdbc 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,22 @@ # Chili3D -[Chili3D](https://chili3d.com) is a fast, web-based 3D CAD program that works in any modern browser. Built with TypeScript, Three.js, and Opencascade.js. +[Chili3D](https://chili3d.com) is an open source 3D CAD software that runs in any modern web browser. It is built with TypeScript and uses OpenCascade and Three.js for 3D modeling and rendering. Chili3D offers a simple and user-friendly interface that allows you to easily create and modify 3D models. ![screenshot](screenshots/screenshot.png) -## WARNING - -Chili3D is still in the very early stages of development. APIs can and will change (now is the time to make suggestions!). Important features are missing. Documentation is sparse. Please don't build any serious projects in Chili3D unless you are prepared to be broken by API changes constantly. - ## Features -The app hosted at chili3d.com is a minimal showcase of what you can build with chili3d. Its features: - - Open-source (https://github.com/xiangechen/chili3d.git). +- Runs on modern web browsers (https://chili3d.com). - Localization (i18n) support. -- Export to STEP, IGES, BREP... -- Open format - export document as an .cd json file. -- Snap and Track. +- Simple and intuitive user interface. +- Highly flexible hierarchical organization of models. - Wide range of tools - rectangle, circle, line, box, prism, sweep... +- Import and export STEP, IGES, BREP... +- Snap and Track. - Undo / Redo. - Local-first support (save to the browser). +- Open format - save as an .cd json file. ## How to Use @@ -33,3 +30,7 @@ $ npm run dev ``` Then open http://localhost:8080/ to use Chili3D. + +## WARNING + +Chili3D is still in the very early stages of development. APIs can and will change (now is the time to make suggestions!). Important features are missing. Documentation is sparse. Please don't build any serious projects in Chili3D unless you are prepared to be broken by API changes constantly.