nissy-core

commit 57f194ef57e393d84e2d3c73115ec528e02ea3c9
parent f74438386c6ba50cba75de93040c5230dac99359
Author: Sebastiano Tronto <sebastiano@tronto.net>
Date:   Fri, 30 May 2025 14:39:37 +0200

Added dev documentation

Diffstat:
A
doc/api-changes.md
 | 
14
++++++++++++++

1 file changed, 14 insertions(+), 0 deletions(-)
diff --git a/doc/api-changes.md 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/`.