Skip to content

Commit dffcf4f

Browse files
authored
Fix empty README issue on PyPi (#626)
* Fix empty README issue on PyPi * Fix link * Fix link again * Skip check links * Ignore check-links for main README * Update links
1 parent e1d4ee2 commit dffcf4f

File tree

2 files changed

+47
-47
lines changed

2 files changed

+47
-47
lines changed

README.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
./python/jupytercad/README.md

python/jupytercad/README.md

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,46 @@
1-
# JupyterCad meta-package
1+
# JupyterCAD - A JupyterLab extension for 3D geometry modeling.
2+
3+
[![Lite](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://jupytercad.github.io/JupyterCAD/)
4+
5+
JupyterCAD is a JupyterLab extension for 3D geometry modeling with collaborative editing support. It is designed to allow multiple people to work on the same file at the same time, and to facilitate discussion and collaboration around the 3D shapes being created.
6+
7+
JupyterCAD has support for FreeCAD files, which makes it easy to import and export models from FreeCAD. It also has a range of features for creating and manipulating 3D shapes, including a variety of primitives, transformations, and Boolean operations.
8+
9+
![jupytercad](https://raw.githubusercontent.com/jupytercad/JupyterCAD/refs/heads/main/docs/source/assets/jupytercad-screenshot.png)
10+
11+
## Requirements
12+
13+
- JupyterLab >= 4.0.0
14+
- freecad (optional)
15+
16+
## Installation
17+
18+
You can install JupyterCAD using conda/mamba (this installs freecad automatically):
19+
20+
```bash
21+
mamba install -c conda-forge jupytercad
22+
```
23+
24+
Or using pip:
25+
26+
```bash
27+
pip install jupytercad
28+
```
29+
30+
Once you have installed the extension, you should be able to open the CAD viewer in JupyterLab and create 3D shapes!
31+
32+
Additionally, you can install `jupytercad-freecad` and edit `.FCStd` files in JupyterLab.
33+
34+
## Documentation
35+
36+
Check out the JupyterCAD documentation on ReadTheDocs! https://jupytercad.readthedocs.io
37+
38+
## Contributing
39+
40+
JupyterCAD is an open-source project, and contributions are always welcome. If you would like to contribute to JupyterCAD, please fork the repository and submit a pull request.
41+
42+
See [CONTRIBUTING](https://github.com/jupytercad/JupyterCAD/blob/main/CONTRIBUTING.md) for dev installation instructions.
43+
44+
## License
45+
46+
JupyterCAD is licensed under the BSD 3-Clause License. See the LICENSE file for more information.

0 commit comments

Comments
 (0)