Use the shared section names in the README
Installation -> Quick start, and the build commands move into it so the file ends on Layout then More like every other repo. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WsxkJEmqEECM1PygXdN1zU
This commit is contained in:
@@ -15,7 +15,7 @@ kernel; run `tools/inventory.py` for the current count. Adding a class is a
|
|||||||
routine, documented change, see
|
routine, documented change, see
|
||||||
[docs/adding-symbols.md](docs/adding-symbols.md).
|
[docs/adding-symbols.md](docs/adding-symbols.md).
|
||||||
|
|
||||||
## Installation
|
## Quick start
|
||||||
|
|
||||||
The packages sit on our Gitea instance, so install by pointing at its index:
|
The packages sit on our Gitea instance, so install by pointing at its index:
|
||||||
|
|
||||||
@@ -27,6 +27,17 @@ uv pip install --index-url https://git.stroblme.de/api/packages/N3XD/pypi/simple
|
|||||||
Versions are `<occt-version>.N`, enforced at configure time against the OCCT
|
Versions are `<occt-version>.N`, enforced at configure time against the OCCT
|
||||||
actually found.
|
actually found.
|
||||||
|
|
||||||
|
Wheels are built on a dev box and published to that registry. To build one
|
||||||
|
yourself, everything runs in the OCCT builder image, so Docker is the only
|
||||||
|
prerequisite:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make image # compiles OCCT 8.0.1 into the builder image
|
||||||
|
make dev # incremental compile + tests
|
||||||
|
make wheel # compile, stubs, auditwheel, self-containment smoke test
|
||||||
|
make publish # publish to Gitea using .secret credentials
|
||||||
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
`OCP` mirrors `cadquery-ocp` symbol-for-symbol, so code written against it runs
|
`OCP` mirrors `cadquery-ocp` symbol-for-symbol, so code written against it runs
|
||||||
@@ -99,19 +110,6 @@ builder.perform()
|
|||||||
| `occt/` | The Dockerfile that compiles OCCT 8.0.1 into the builder image |
|
| `occt/` | The Dockerfile that compiles OCCT 8.0.1 into the builder image |
|
||||||
| `tools/` | Inventory, signature diffing against upstream, and benchmarks |
|
| `tools/` | Inventory, signature diffing against upstream, and benchmarks |
|
||||||
|
|
||||||
## Build
|
|
||||||
|
|
||||||
Wheels are built on a dev box and published to the
|
|
||||||
[Gitea package registry](https://git.stroblme.de/api/packages/N3XD/pypi). To
|
|
||||||
build one yourself:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
make image # compiles OCCT 8.0.1 into the builder image
|
|
||||||
make dev # incremental compile + tests
|
|
||||||
make wheel # compile, stubs, auditwheel, self-containment smoke test
|
|
||||||
make publish # publish to Gitea using .secret credentials
|
|
||||||
```
|
|
||||||
|
|
||||||
## More
|
## More
|
||||||
|
|
||||||
- [docs/design.md](docs/design.md) — the decisions and the handle model
|
- [docs/design.md](docs/design.md) — the decisions and the handle model
|
||||||
|
|||||||
Reference in New Issue
Block a user