Skip to content

Commit

Permalink
Improve cmake doc
Browse files Browse the repository at this point in the history
  • Loading branch information
xmos-jmccarthy committed Aug 11, 2022
1 parent 158486a commit 4ab9ae2
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions doc/tutorials/build_system/cmakelists.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
######################
Example CMakeLists.txt
Example CMakeLists.txt
######################

.. note::

CMake is powerful tool that provides the developer a great deal of flexibility in how their projects are built. As a result, CMakeLists.txt files in the example applications may vary from the examples below. This example can be used as a starting point for your bare-metal application. Or, you may choose to copy a ``CMakeLists.txt`` from one of the applications in the SDK that closely resembles your application.


This repository supports being added as a CMake subproject. A parent CMake project can use add_subdirectory() to include the xcore_sdk as a subproject.

.. note::

The xcore_sdk subproject should be added before declaring application targets, as some xcore_sdk provided macros may be needed. Addtionally, when included as a subproject, xcore_sdk examples targets are not added to the CMake build.

**********
Bare-Metal
**********
Expand Down Expand Up @@ -133,4 +140,4 @@ Below is an example ``CMakeLists.txt`` that shows both required and conventional
## Optionally create run and debug targets
create_run_target(my_app)
create_debug_target(my_app)
create_debug_target(my_app)

0 comments on commit 4ab9ae2

Please sign in to comment.