diff --git a/README.md b/README.md index 1d7d1e1..727be44 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ A C++20 Kahn Process Network (KPN) library. Each node wraps a function and runs in its own thread, communicating with downstream nodes via bounded FIFO channels. Includes Python bindings via nanobind. +📖 **[Documentation](https://pages.tourolle.paris/dtourolle/kpn/)** + --- ## Requirements @@ -398,8 +400,8 @@ Violating the second rule deadlocks. | `04_storage_policy` | `channel_storage_policy` default and specialisation | | `05_error_handling` | `ChannelOverflowError`, `ErrorHandler` | | `06_watchdog` | Watchdog interval, stall detection | -| `07_python_network` | PyNetwork, pure Python node *(pending)* | -| `08_python_subport` | `net.read`, `net.write`, sub-port tap *(pending)* | +| `07_python_network` | PyNetwork with a pure-Python node between a C++ source and sink | +| `08_python_subport` | Drive a Python node from Python via `net.write`/`net.read` sub-port taps | | `09_opencv_cellshade` | Real-time cell-shading on webcam/pattern; requires OpenCV ≥ 4 | Run the cell-shading example: diff --git a/README.md.in b/README.md.in index cd821d4..4d7622b 100644 --- a/README.md.in +++ b/README.md.in @@ -2,6 +2,8 @@ A C++20 Kahn Process Network (KPN) library. Each node wraps a function and runs in its own thread, communicating with downstream nodes via bounded FIFO channels. Includes Python bindings via nanobind. +📖 **[Documentation](https://pages.tourolle.paris/dtourolle/kpn/)** + --- ## Requirements @@ -220,8 +222,8 @@ Violating the second rule deadlocks. | `04_storage_policy` | `channel_storage_policy` default and specialisation | | `05_error_handling` | `ChannelOverflowError`, `ErrorHandler` | | `06_watchdog` | Watchdog interval, stall detection | -| `07_python_network` | PyNetwork, pure Python node *(pending)* | -| `08_python_subport` | `net.read`, `net.write`, sub-port tap *(pending)* | +| `07_python_network` | PyNetwork with a pure-Python node between a C++ source and sink | +| `08_python_subport` | Drive a Python node from Python via `net.write`/`net.read` sub-port taps | | `09_opencv_cellshade` | Real-time cell-shading on webcam/pattern; requires OpenCV ≥ 4 | Run the cell-shading example: