From 10dc0b2e639b2ec2ad0317764eecba7297b35534 Mon Sep 17 00:00:00 2001 From: Peter Thedens <pthedens@iastate.edu> Date: Wed, 8 Nov 2017 15:56:54 -0600 Subject: [PATCH] Add markdown for the makefiles --- quad/README.md | 6 +++++- quad/doc/Makefiles.md | 4 ++++ 2 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 quad/doc/Makefiles.md diff --git a/quad/README.md b/quad/README.md index 896b2aa3b..b60aa8d3b 100644 --- a/quad/README.md +++ b/quad/README.md @@ -65,6 +65,8 @@ cd src/<project> && make **NOTE**: All build artifacts will be placed in `lib` or `bin` (depending on whether it is a library or executable, respectively) +To learn more about the makefiles, see [Makefiles.md](doc/Makefiles.md) + ## Testing #### Automated Tests @@ -92,9 +94,11 @@ Ideally, you would run these tests from the XSDK IDE. * [The Quad Application](src/quad_app/README.md) * [Quad App on the Zybo (Real Quad)](xsdk_workspace/real_quad/README.md) * [Quad App on Unix (Virtual Quad)](src/virt_quad/README.md) -* [XSDK Instructions](xsdk_workspace/README.md) +* [XSDK Instructions](xsdk_workspace/README.md) +* [How to use the makefile structure](doc/) ## Other Documents * [Hardware Block Diagram](doc/images/FPGA_Diagram.png) * [Zybo Pinout Assignments](doc/zybo_pinout_assignments.md) * [How to use Xilinx software tools](doc/how_to_use_XSDK.md) +* [How to use the makefile structure](doc/Makefiles.md) diff --git a/quad/doc/Makefiles.md b/quad/doc/Makefiles.md new file mode 100644 index 000000000..7aa684fc2 --- /dev/null +++ b/quad/doc/Makefiles.md @@ -0,0 +1,4 @@ +# How to use the makefiles + + + -- GitLab