Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve cmake doc #506

Merged
merged 2 commits into from
Aug 14, 2022
Merged

Improve cmake doc #506

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ab9ae2
Improve cmake doc
xmos-jmccarthy Aug 11, 2022
619b4a3
Fix typo
xmos-jmccarthy Aug 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions doc/tutorials/build_system/cmakelists.rst
View file
Open in desktop
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. Additionally, 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)