From 57f194ef57e393d84e2d3c73115ec528e02ea3c9 Mon Sep 17 00:00:00 2001 From: Sebastiano Tronto Date: Fri, 30 May 2025 14:39:37 +0200 Subject: Added dev documentation --- doc/api-changes.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 doc/api-changes.md diff --git a/doc/api-changes.md b/doc/api-changes.md new file mode 100644 index 0000000..f3b8ac5 --- /dev/null +++ b/doc/api-changes.md @@ -0,0 +1,14 @@ +# TO-DO list for API changes + +When `nissy.h` is modified, for example because a new API function is added or +one of the old ones changes signature, all the examples and tools that include +this file must be adapted. Here is a list: + +* Update the tools in `tools/`. +* Update the shell `shell/shell.c`. +* Update the python module `python/nissy_module.c` and, if needed, the + examples in `python/examples/`. +* Update the C++ adapter `cpp/nissy.{cpp,h}` and, if needed, the examples in + `cpp/examples/`. +* Update the web adapter `web/adapter.cpp` (based on the C++ header) and, + if needed, the example webapp in `web/http/`. -- cgit v1.3