From 5a387ecb4da8055e147c0dc945148fca08ae6189 Mon Sep 17 00:00:00 2001 From: Hasan Zakeri Date: Tue, 21 Apr 2026 17:59:58 -0700 Subject: [PATCH] docs: fix stale package name and plan link Update ROADMAP.md to use the pyharfrust package name (python/pyharfrust/ and pyharfrust.shape()) and point README.md at ROADMAP.md instead of the renamed PLAN.md. --- README.md | 2 +- ROADMAP.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b21e1e3..082b5b6 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ HarfBuzz is the industry-standard text shaping engine used by Firefox, Chrome, A ## Status -This project is in early development. See the [development plan](https://github.com/nickkuk/harfrust-python/blob/main/PLAN.md) for the phased roadmap. +This project is in early development. See the [development plan](https://github.com/nickkuk/harfrust-python/blob/main/ROADMAP.md) for the phased roadmap. ## License diff --git a/ROADMAP.md b/ROADMAP.md index 67546f6..a568f22 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -2,7 +2,7 @@ ## Phase 1 — Project Skeleton -Buildable Python package that imports successfully. Set up `Cargo.toml` (PyO3 cdylib), `pyproject.toml` (maturin backend), a minimal `src/lib.rs` with a version function, and `python/harfrust/__init__.py` that re-exports it. Include an MIT `LICENSE` file and a GitHub Actions CI workflow (`maturin develop` + `pytest`). +Buildable Python package that imports successfully. Set up `Cargo.toml` (PyO3 cdylib), `pyproject.toml` (maturin backend), a minimal `src/lib.rs` with a version function, and `python/pyharfrust/__init__.py` that re-exports it. Include an MIT `LICENSE` file and a GitHub Actions CI workflow (`maturin develop` + `pytest`). **Done when:** `maturin develop && pytest` passes with a single `test_import` test, LICENSE exists, and CI is green. @@ -16,7 +16,7 @@ Expose `Direction`, `Script`, `Language`, `Feature`, and `Variation` as Python c Wrap `hr_shape::shape()` and `hr_shape::run_from_args()` as top-level Python functions. Set up a `.tests` regression suite with bundled test fonts and data, plus optional discovery of an external harfrust checkout via `HARFRUST_SOURCE`. -**Done when:** `harfrust.shape(font_path, text, options)` returns a serialized glyph string and bundled `.tests` cases pass. +**Done when:** `pyharfrust.shape(font_path, text, options)` returns a serialized glyph string and bundled `.tests` cases pass. ## Phase 4 — Buffer Class