Merge pull request #20 from creativecommons/readme-ci

added black and flake8 info

Author: TimidRobot

README.md

@@ -64,15 +64,30 @@ This will generate the icons in the directory `www/i` directory.
 
 ### Development
 
-- *Pycairo is a Python module providing bindings for the cairo graphics
-  library* ([Overview — Pycairo documentation][pycairo]).
-- *PyGObject is a Python package which provides bindings for GObject based
-  libraries such as GTK, GStreamer, WebKitGTK, GLib, GIO and many more*
-  ([Overview — PyGObject][pygobject]).
-- PangoCairo is used to load the system fonts and check if the "CC Icons" font
-  is available. See [PangoCairo.FontMap - Interfaces -
-  PangoCairo 1.0][pcfontmap].
-
+- Style/Syntax
+  - Github Actions check the style and syntax with [black][black] and
+    [flake8][flake8]. Run the following commands before submitting a pull
+    request:
+    - Reformat with black using a maxiumum of 79 charaters per line:
+        ```shell
+        black -l 79 ./scripts/genicons.py
+        ```
+    - Check syntax with flake8:
+        ```shell
+        flake8 ./scripts/genicons.p
+        ```
+- Dependencies
+  - *Pycairo is a Python module providing bindings for the cairo graphics
+    library* ([Overview — Pycairo documentation][pycairo]).
+  - *PyGObject is a Python package which provides bindings for GObject based
+    libraries such as GTK, GStreamer, WebKitGTK, GLib, GIO and many more*
+    ([Overview — PyGObject][pygobject]).
+  - PangoCairo is used to load the system fonts and check if the "CC Icons" font
+    is available. See [PangoCairo.FontMap - Interfaces -
+    PangoCairo 1.0][pcfontmap].
+
+[black]: https://github.com/python/black
+[flake8]: https://gitlab.com/pycqa/flake8
 [pycairo]: https://pycairo.readthedocs.io/en/latest/
 [pygobject]: https://pygobject.readthedocs.io/en/latest/index.html
 [pcfontmap]: https://lazka.github.io/pgi-docs/PangoCairo-1.0/classes/FontMap.html#PangoCairo.FontMap