apib11: doc

Author: jmmuller

MMVII/apib11/.gitignore

@@ -7,7 +7,8 @@ Tmp-MM-Dir
 *.jpg
 *.TIF
 *.tif
-Dist/
-build/
+/dist/
+/build/
 MMVII.egg-info/
 Tmmmp-MM-Dir/
+__pycache__

MMVII/apib11/README.md

@@ -1,2 +1,40 @@
-pip3 install pybind11_mkdoc
+MicMac v2 Python3 API
+=====================
 
+Compilation
+-----------
+
+First, compile MMv1 and MMv2.
+
+Then, in 'apib11' directory:
+
+    make
+
+The module can be used from this directory without installation (this local version has priority to installed modules).
+
+Installation
+------------
+
+    make install
+
+Distribution
+------------
+
+The file dist/MMVII-*.whl, created at compilation, can be distributed to machines with same OS, arch and python version.
+
+It can be installed with:
+
+    pip3 install MMVII-*.whl
+
+Upgrade pip if needed:
+
+    python3 -m pip install --upgrade pip
+
+Usage
+-----
+
+```python
+    import MMVII
+```
+
+See 'examples' directory for use cases.

MMVII/apib11/pyproject.toml

@@ -1,3 +1,3 @@
 [build-system]
-requires = ["setuptools", "wheel", "pybind11"]
+requires = ["setuptools", "wheel", "pybind11", "pybind11_mkdoc"]
 build-backend = "setuptools.build_meta"