Skip to content

Commit 2310630

Browse files
committed
added black and flake8 info
1 parent 2e6159c commit 2310630

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

README.md

+22-9
Original file line numberDiff line numberDiff line change
@@ -64,15 +64,28 @@ This will generate the icons in the directory `www/i` directory.
6464

6565
### Development
6666

67-
- *Pycairo is a Python module providing bindings for the cairo graphics
68-
library* ([Overview — Pycairo documentation][pycairo]).
69-
- *PyGObject is a Python package which provides bindings for GObject based
70-
libraries such as GTK, GStreamer, WebKitGTK, GLib, GIO and many more*
71-
([Overview — PyGObject][pygobject]).
72-
- PangoCairo is used to load the system fonts and check if the "CC Icons" font
73-
is available. See [PangoCairo.FontMap - Interfaces -
74-
PangoCairo 1.0][pcfontmap].
75-
67+
- Style/Syntax
68+
- Github Actions check the style and syntax with [black][black] and
69+
[flake8][flake8]. Run the following commands before submitting a pull
70+
request:
71+
```shell
72+
black -l 79 ./scripts/genicons.py
73+
```
74+
```
75+
flake8 ./scripts/genicons.p
76+
```
77+
- Dependencies
78+
- *Pycairo is a Python module providing bindings for the cairo graphics
79+
library* ([Overview — Pycairo documentation][pycairo]).
80+
- *PyGObject is a Python package which provides bindings for GObject based
81+
libraries such as GTK, GStreamer, WebKitGTK, GLib, GIO and many more*
82+
([Overview — PyGObject][pygobject]).
83+
- PangoCairo is used to load the system fonts and check if the "CC Icons" font
84+
is available. See [PangoCairo.FontMap - Interfaces -
85+
PangoCairo 1.0][pcfontmap].
86+
87+
[black]: https://github.com/python/black
88+
[flake8]: https://gitlab.com/pycqa/flake8
7689
[pycairo]: https://pycairo.readthedocs.io/en/latest/
7790
[pygobject]: https://pygobject.readthedocs.io/en/latest/index.html
7891
[pcfontmap]: https://lazka.github.io/pgi-docs/PangoCairo-1.0/classes/FontMap.html#PangoCairo.FontMap

0 commit comments

Comments
 (0)