From d2d955c63dc2895302a395f00ccc473e1992c8c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lionel=20F=C3=A9licit=C3=A9?= Date: Sun, 20 Sep 2020 16:15:17 +0200 Subject: [PATCH] [DOC]Add link between contribute and development docs Try to lead newcomer into the "prefered" way --- CONTRIBUTING.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 22aa1475..7f42a2da 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,6 +3,10 @@ You shouldn't edit the node class files (all files under `diagrams/` directory) by yourself. +## Set up your environment + +* cf. [DEVELOPMENT.md][DEVELOPMENT.md] + ## Resources ### Update nodes @@ -24,14 +28,15 @@ convert -resize 256 my_big_image.jpg my_image.jpg ffmpeg -i my_big_image.jpg -vf scale=w=256:h=256:force_original_aspect_ratio=decrease my_image.png ``` -Then just run the `./autogen.sh` to generate the added or updated node classes. +Then just run the `./autogen.sh` to generate the added or updated node classes. (cf. [DEVELOPMENT.md][DEVELOPMENT.md]) > IMPORTANT NOTE: To run `autogen.sh`, you need [round][round] and > [inkscape][inkscape] command lines that are used for cleaning the image -> resource filenames. +> resource filenames. Or you should the docker image > > macOS users can download the inkscape via Homebrew. +[DEVELOPMENT.md]: ./DEVELOPMENT.md [round]: https://github.com/mingrammer/round [inkscape]: https://inkscape.org/ko/release @@ -44,11 +49,11 @@ from `ALIASES` map in [config.py](config.py). So, if you want to add new aliases or update existing aliases, you can just add or update the `ALIASES` map in [config.py](config.py). -Then just run the `./autogen.sh` to generate the added or updated aliases. +Then just run the `./autogen.sh` to generate the added or updated aliases. (cf. [DEVELOPMENT.md][DEVELOPMENT.md]) > IMPORTANT NOTE: To run `autogen.sh`, you need [round][round] and > [inkscape][inkscape] command lines that are used for clearning the image -> resource filenames. +> resource filenames. Or you should the docker image ## Run Tests