From 16852b6592e2d99e9d311cdc253e796095bc7509 Mon Sep 17 00:00:00 2001 From: dawehr <dawehr@iastate.edu> Date: Sun, 12 Feb 2017 01:22:00 -0600 Subject: [PATCH] Added README with instructions for gen_diagram --- quad/sw/modular_quad_pid/gen_diagram/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 quad/sw/modular_quad_pid/gen_diagram/README.md diff --git a/quad/sw/modular_quad_pid/gen_diagram/README.md b/quad/sw/modular_quad_pid/gen_diagram/README.md new file mode 100644 index 000000000..1ab705462 --- /dev/null +++ b/quad/sw/modular_quad_pid/gen_diagram/README.md @@ -0,0 +1,10 @@ +The gen_diagram project can create an image of the controller network. Below outlines the process of how to use it. + +Within the `quad/sw/modular_quad_pid` directory: + +1. Copy the `control_algorithm_init` function from `src/control_algorithm.c` into `gen_diagram/generate.c`, replacing the previous implementation. +2. Within the `gen_diagram` folder, run `make clean`. Then run `make` to build the new code. +3. Now execute the program with `./gen_diagram` +4. If you have graphviz installed, you can run `dot -Tpng network.dot -o network.png` to generate a PNG file of the graph. + +Enjoy your new diagram! \ No newline at end of file -- GitLab