From 806bf04942d4b50ce7037e5fb482f254fc47f071 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lionel=20F=C3=A9licit=C3=A9?= Date: Thu, 17 Sep 2020 23:21:29 +0200 Subject: [PATCH] [CONTRIBUTING] Add non specified dependencies Missing infos when I tried to contribute --- CONTRIBUTING.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 22aa1475..7038c7fa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,13 +26,15 @@ ffmpeg -i my_big_image.jpg -vf scale=w=256:h=256:force_original_aspect_ratio=dec Then just run the `./autogen.sh` to generate the added or updated node classes. -> IMPORTANT NOTE: To run `autogen.sh`, you need [round][round] and +> IMPORTANT NOTE: To run `autogen.sh`, you need [round][round], [black][black], [jinja2][jinja2] and > [inkscape][inkscape] command lines that are used for cleaning the image > resource filenames. > > macOS users can download the inkscape via Homebrew. [round]: https://github.com/mingrammer/round +[black]: https://github.com/psf/black +[jinja2]: https://pypi.org/project/Jinja2/ [inkscape]: https://inkscape.org/ko/release ### Update Aliases @@ -46,7 +48,7 @@ or update the `ALIASES` map in [config.py](config.py). Then just run the `./autogen.sh` to generate the added or updated aliases. -> IMPORTANT NOTE: To run `autogen.sh`, you need [round][round] and +> IMPORTANT NOTE: To run `autogen.sh`, you need [round][round], [black][black], [jinja2][jinja2] and > [inkscape][inkscape] command lines that are used for clearning the image > resource filenames. @@ -56,6 +58,10 @@ Then just run the `./autogen.sh` to generate the added or updated aliases. python -m unittest tests/*.py -v ``` +> [graphviz][graphviz] is needed to run the tests + +[graphviz]: https://pypi.org/project/graphviz/ + ## Testing changes to the website The [Docusaurus](https://docusaurus.io/)-based documentation website can be run by installing dependencies, then simply running `npm run start`.