Skip to content

Commit 202f2ef

Browse files
committed
🐎 ci: release 0.5
1 parent 24f87c1 commit 202f2ef

File tree

13 files changed

+48
-26
lines changed

13 files changed

+48
-26
lines changed

README.md

Lines changed: 37 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
# Chili3D
22

3-
[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.
3+
[Chili3D](https://chili3d.com) is an open-source 3D CAD software that runs directly in modern web browsers. Built with TypeScript and leveraging OpenCascade with Three.js for 3D modeling and rendering, Chili3D provides a user-friendly interface for creating and modifying 3D models with ease.
44

55
![screenshot](screenshots/screenshot.png)
66

77
## Features
88

9-
- Open-source (https://github.com/xiangechen/chili3d.git).
10-
- Runs on modern web browsers (https://chili3d.com).
11-
- Localization (i18n) support.
12-
- Simple and intuitive user interface.
13-
- Highly flexible hierarchical organization of models.
14-
- Wide range of tools - rectangle, circle, line, box, prism, sweep...
15-
- Import and export STEP, IGES, BREP...
16-
- Snap and Track.
17-
- Undo / Redo.
18-
- Local-first support (save to the browser).
19-
- Open format - save as an .cd json file.
9+
- Open-source (https://github.com/xiangechen/chili3d.git).
10+
- Runs on modern web browsers (https://chili3d.com).
11+
- Multi-language support (i18n).
12+
- Simple and intuitive user interface.
13+
- Highly flexible hierarchical organization of models.
14+
- Wide range of tools - rectangle, circle, line, box, prism, sweep...
15+
- Import and export STEP, IGES, BREP...
16+
- Snap and Track.
17+
- Undo / Redo.
18+
- Local-first support (save to the browser).
19+
- Open format - save as an .cd json file.
2020

2121
## How to Use
2222

23-
This project requires Node.js to be installed.
23+
Prerequisite: Node.js (v20+ recommended)
2424

2525
```bash
2626
$ git clone https://github.com/xiangechen/chili3d.git
@@ -31,6 +31,28 @@ $ npm run dev
3131

3232
Then open http://localhost:8080/ to use Chili3D.
3333

34-
## WARNING
34+
## Development Status
3535

36-
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.
36+
**⚠️ Early Development Notice**
37+
38+
Chili3D is currently in active alpha development. Key considerations:
39+
40+
- Core APIs may undergo breaking changes
41+
- Essential features are under implementation
42+
- Documentation is being progressively developed
43+
44+
## Contributions
45+
46+
We welcome your contributions: in the form of code, bug reports or feedback.
47+
48+
## Contact us
49+
50+
Feel free to join [Github discussions](https://github.com/xiangechen/chili3d/discussions) for general chat or questions. Use [Github issues](https://github.com/xiangechen/chili3d/issues) to report public suggestions or bugs.
51+
52+
You can of course also contact us privately via email to [email protected]
53+
54+
## License
55+
56+
Distributed under the GNU Affero General Public License v3.0 (AGPL-3.0). For commercial licensing options, contact [email protected]
57+
58+
Full license details: [LICENSE](LICENSE)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "chili3d",
3-
"version": "0.5-beta",
3+
"version": "0.5",
44
"description": "",
55
"author": "仙阁",
66
"scripts": {

packages/chili-builder/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "chili-builder",
3-
"version": "0.5-beta",
3+
"version": "0.5",
44
"description": "",
55
"main": "src/index.ts",
66
"devDependencies": {

packages/chili-core/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "chili-core",
3-
"version": "0.5-beta",
3+
"version": "0.5",
44
"description": "",
55
"main": "src/index.ts",
66
"devDependencies": {}

packages/chili-geo/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "chili-geo",
3-
"version": "0.5-beta",
3+
"version": "0.5",
44
"description": "",
55
"main": "src/index.ts",
66
"devDependencies": {

packages/chili-storage/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "chili-storage",
3-
"version": "0.5-beta",
3+
"version": "0.5",
44
"description": "",
55
"main": "src/index.ts",
66
"devDependencies": {

packages/chili-three/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "chili-three",
3-
"version": "0.5-beta",
3+
"version": "0.5",
44
"description": "",
55
"main": "src/index.ts",
66
"devDependencies": {

packages/chili-ui/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "chili-ui",
3-
"version": "0.5-beta",
3+
"version": "0.5",
44
"description": "",
55
"main": "src/index.ts",
66
"devDependencies": {

packages/chili-vis/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "chili-vis",
3-
"version": "0.5-beta",
3+
"version": "0.5",
44
"description": "",
55
"main": "src/index.ts",
66
"devDependencies": {

packages/chili-wasm/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "chili-wasm",
3-
"version": "0.5-beta",
3+
"version": "0.5",
44
"description": "",
55
"main": "src/index.ts",
66
"type": "module",

packages/chili-web/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "chili-web",
3-
"version": "0.5-beta",
3+
"version": "0.5",
44
"description": "",
55
"main": "src/index.ts",
66
"devDependencies": {

packages/chili/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "chili",
3-
"version": "0.5-beta",
3+
"version": "0.5",
44
"description": "",
55
"main": "src/index.ts",
66
"devDependencies": {

screenshots/screenshot.png

328 KB
Loading

0 commit comments

Comments
 (0)