Skip to content

Commit 5e120e5

Browse files
authored
Update readme
1 parent 6c6b44f commit 5e120e5

1 file changed

Lines changed: 11 additions & 27 deletions

File tree

README.md

Lines changed: 11 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ With OpenVCAD, you can:
1717

1818
---
1919

20-
## 🖼 Gallery
20+
## Gallery
2121

2222
Here are a few examples of what OpenVCAD can produce:
2323

@@ -35,7 +35,13 @@ Here are a few examples of what OpenVCAD can produce:
3535

3636
---
3737

38-
## 📚 Publications
38+
## Getting Started
39+
40+
See our [starter project](https://github.com/MacCurdyLab/OpenVCAD-Public/tree/main/examples/project_example) for more information on installing OpenVCAD.
41+
42+
---
43+
44+
## Publications
3945

4046
OpenVCAD is an active research project developed by the [Matter Assembly Computation Lab](https://www.colorado.edu/lab/matterassembly/) at CU Boulder.
4147
1. **OpenVCAD: An open‑source volumetric multi‑material geometry compiler** (2024)
@@ -93,29 +99,7 @@ OpenVCAD is **not** a voxel-by-voxel design tool. While it can emit voxel data,
9399

94100
---
95101

96-
## 🛠 Installation
97-
OpenVCAD can be used in two main ways:
98-
99-
### 1. **OpenVCAD Studio** (GUI IDE)
100-
> [Read our install guide](https://github.com/MacCurdyLab/OpenVCAD-Public/wiki/Installing-OpenVCAD-Studio)
101-
- A standalone IDE for creating, previewing, and exporting designs with `pyvcad`.
102-
- Ships with `pyvcad` built-in — no separate Python install needed.
103-
- Available for **Windows** and **macOS (Apple Silicon)**.
104-
- Download the latest release from the [Releases page](https://github.com/MacCurdyLab/OpenVCAD-Public/releases).
105-
106-
### 2. **pyvcad** (Python library)
107-
> For advanced users
108-
- Python bindings to the OpenVCAD C++ kernel.
109-
- Installable via PyPI:
110-
```bash
111-
pip install OpenVCAD
112-
```
113-
- Best for algorithmic workflows, integration with simulation, or headless rendering.
114-
- Runs on Windows and macOS.
115-
116-
---
117-
118-
## 📥 Getting the Code
102+
## Getting the Code
119103

120104
The OpenVCAD source code is open-source under a **non-commercial license**.
121105
You can request access to the private GitHub repository here:
@@ -124,14 +108,14 @@ You can request access to the private GitHub repository here:
124108

125109
---
126110

127-
## 📄 License
111+
## License
128112

129113
OpenVCAD is released under a **non-commercial open-source license**.
130114
See the [LICENSE](LICENSE) file for details.
131115

132116
---
133117

134-
## 🗣 Citing OpenVCAD
118+
## Citing OpenVCAD
135119
If you use OpenVCAD in your research, please cite:
136120

137121
```bibtex

0 commit comments

Comments
 (0)