aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken6/doc/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'sources/shiboken6/doc/README.md')
-rw-r--r--sources/shiboken6/doc/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/sources/shiboken6/doc/README.md b/sources/shiboken6/doc/README.md
new file mode 100644
index 000000000..2575eafd2
--- /dev/null
+++ b/sources/shiboken6/doc/README.md
@@ -0,0 +1,12 @@
+# Shiboken Documentation
+
+The documentation was written and needs to be generated
+with [python-sphinx](http://www.sphinx-doc.org/en/master/)
+
+### Images
+
+The SVG diagrams use the Qt color scheme.
+The font also follows Qt styling, and it is called `Titillium`.
+It can be download from:
+* https://fonts.google.com/specimen/Titillium+Web
+* https://www.fontsquirrel.com/fonts/Titillium