Skip to content

Commit a077128

Browse files
Update documentation.
1 parent b314faa commit a077128

2 files changed

Lines changed: 6 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,19 @@ Before submitting a pull request, please run:
4242
```bash
4343
black .
4444
ruff check .
45-
mypy core
45+
mypy morphe --exclude 'morphe/adapters/(freecad|fusion|inventor|solidworks)/'
4646
```
4747

4848
## Adding a New CAD Adapter
4949

5050
All adapters are implemented in Python. To add support for a new CAD system:
5151

52-
1. Create a new package: `adapter_<cadname>/`
53-
2. Implement the `SketchBackendAdapter` abstract base class from `adapter_common`
52+
1. Create a new package: `morphe/adapters/<cadname>/`
53+
2. Implement the `SketchBackendAdapter` abstract base class from `morphe.adapters.common`
5454
3. Add tests in `tests/test_<cadname>_adapter.py` or within the adapter package
5555
4. Update the README to mention the new adapter
5656

57-
See `adapter_freecad/` for a reference implementation. For Windows COM-based CAD systems (like SolidWorks or Inventor), see `adapter_solidworks/` for patterns using `pywin32`.
57+
See `morphe/adapters/freecad/` for a reference implementation. For Windows COM-based CAD systems (like SolidWorks or Inventor), see `morphe/adapters/solidworks/` for patterns using `pywin32`.
5858

5959
## Pull Request Guidelines
6060

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Morphe
22

3+
*Pronounced "mor-FAY" (from Greek [μορφή](https://en.wiktionary.org/wiki/%CE%BC%CE%BF%CF%81%CF%86%CE%AE), meaning "form" or "shape")*
4+
35
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
46
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
57
[![Tests](https://github.com/codereclaimers/morphe/actions/workflows/test.yml/badge.svg)](https://github.com/codereclaimers/morphe/actions/workflows/test.yml)

0 commit comments

Comments
 (0)