aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..15a6a68
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# defconQt
+
+`defconQt` is a set of widgets for font-editing applications written with Python3, robofab, defcon and PyQt.
+
+Dependencies:
+
+- [Behdad Esfahbod’s fontTools]
+- [Adrien Tétar’s fork of robofab, python3 branch]
+- [Adrien Tétar’s fork of defcon, python3 branch]
+
+[Behdad Esfahbod’s fontTools]: https://github.com/behdad/fonttools
+[Adrien Tétar’s fork of robofab, python3 branch]: https://github.com/adrientetar/robofab
+[Adrien Tétar’s fork of defcon, python3 branch]: https://github.com/adrientetar/defcon
+
+Run:
+
+`python Lib\defconQt\fontView.py`
+
+The install script is not very reliable just now, but nor is the package. Direct execution is the best
+supported way at the moment. \ No newline at end of file