add readme to cpp docs and update plugin documentation to refer to the new menu

1 files changed, 24 insertions, 0 deletions

diff --git a/api-docs/cppdocs/README.md b/api-docs/cppdocs/README.md
new file mode 100644
index 00000000..237a840c
--- /dev/null
+++ b/api-docs/cppdocs/README.md
@@ -0,0 +1,24 @@
+# CPP Docs
+
+We are currently expirmenting with two different document generation systems. You'll see artifacts for both of them in this directory. Currently, the documentation available [online](https://api.binary.ninja/cpp) uses [Doxygen](https://www.doxygen.nl/index.html) but we plan eventually to move to [Breathe](https://breathe.readthedocs.io/en/latest/) / [Sphinx](https://www.sphinx-doc.org/en/master/).
+
+## Doxygen
+
+Generating documentation with Doxygen couldn't be simpler. Just install it and run:
+
+```
+$ doxygen
+```
+
+From this directory. The output will be stored in `html/`
+
+
+## Breathe/Sphinx
+
+The requirements are already described in our [documentation](https://docs.binary.ninja/dev/documentation.html). Instead, however simply navigate to this directory and use:
+
+```
+sphinx-build -b html . html/
+```
+
+Note that Sphinx will take significantly longer due to some performance issues with breathe and doxygen generated XML. This is the main reason this is not our primary workflow.