summaryrefslogtreecommitdiffstats
path: root/tools/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/README.md')
-rw-r--r--tools/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/tools/README.md b/tools/README.md
new file mode 100644
index 000000000..8fe5a04e0
--- /dev/null
+++ b/tools/README.md
@@ -0,0 +1,32 @@
+README FOR ONAP DOC/TOOLS
+#########################
+
+c2m.sh
+================================================================================
+DESCRIPTION
+
+c2m automates additional tasks required in case you want to export and convert a
+set of wiki pages. for more details see header of the script.
+
+ADDITIONAL FILES
+
+example.pagelist: an example pagelist to demonstrate functionality
+
+SEE ALSO
+
+https://www.viaboxx.de/code/confluence2md/
+
+https://github.com/viaboxxsystems/confluence2md
+
+
+warnstats.sh
+================================================================================
+DESCRIPTION
+
+warnstat helps to find the onap modules (projects) and rst-files which are
+responsible for the most warnings during the documentation build process. for
+more details see header of the script.
+
+ADDITIONAL FILES
+
+example-tox-build.log: an example tox logfile to demonstrate functionality