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 0000000000000000000000000000000000000000..1ab705462f7c4fcdf6a8cf2c6113c12d28bfbf41 --- /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