Skip to content

Commit

Permalink
📃 docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
xiangechen committed Dec 9, 2023
1 parent dce55c6 commit 5749807
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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.

0 comments on commit 5749807

Please sign in to comment.