Skip to content

Commit

Permalink
Updated documentation for "pc show" and "pc render" (#38)
Browse files Browse the repository at this point in the history
  • Loading branch information
openvmp authored Jan 6, 2024
1 parent f76608a commit 3390d0d
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,11 +275,28 @@ import:
At the moment, the best way to troubleshoot PartCAD is to use VS Code with `OCP CAD Viewer`.
Any part or assembly can be displayed in `OCP CAD Viewer` by running `pc show <part> [<package>]` or `pc show -a <assembly> [<package>]` in a terminal view.

```sh
# Create a temporary folder
mkdir /tmp/test_show && cd /tmp/test_show
# Initialize a package with the default dependency on public PartCAD repository
pc init
# Show one of available parts in 'OCP CAD Viewer'
pc show fastener/screw-buttonhead standard-metric-cqwarehouse
```

### Render your project

Use `pc render` to render PartCAD parts and assemblies
in the current package (the current directory).

```sh
git clone https://github.com/openvmp/partcad-cqwarehouse.git
cd partcad-cqwarehouse
pc render
```

### Publishing

It is very simple to publish your package to the public PartCAD repository.
Expand Down

0 comments on commit 3390d0d

Please sign in to comment.