From 0017d8b3eebbea3b1446fe7e9c0d28295103cdce Mon Sep 17 00:00:00 2001 From: Khalil Estell Date: Wed, 27 Mar 2024 18:59:54 -0700 Subject: [PATCH] :memo: Explain how to build apps/demos --- mkdocs/contributor_guide/vscode_setup.md | 15 --------------- mkdocs/summary.md | 1 - mkdocs/user_guide/setup_vscode.md | 15 ++++++++++++++- 3 files changed, 14 insertions(+), 17 deletions(-) delete mode 100644 mkdocs/contributor_guide/vscode_setup.md diff --git a/mkdocs/contributor_guide/vscode_setup.md b/mkdocs/contributor_guide/vscode_setup.md deleted file mode 100644 index cbb1f04d5..000000000 --- a/mkdocs/contributor_guide/vscode_setup.md +++ /dev/null @@ -1,15 +0,0 @@ -# 💻 VSCode Setup - -## Add `~/.conan2/p` to includes path - -TDB - -## Setting the `python` interpreter - -TDB - -## Setting up VSCode Debugger - -!!! info - - Still under investigation... diff --git a/mkdocs/summary.md b/mkdocs/summary.md index 1f05dfc90..775f24786 100644 --- a/mkdocs/summary.md +++ b/mkdocs/summary.md @@ -12,7 +12,6 @@ - [🗃️ Organization](contributor_guide/organization.md) - [🎨 Style Guide](contributor_guide/style.md) - [🔹 Library Development Guide](contributor_guide/library_guides.md) - - [💻 VSCode Setup](contributor_guide/vscode_setup.md) - [⬆️ Upgrade Device Library to 3.x.y](contributor_guide/upgrade_to_libhal_3_device_library.md) - [🏗️ Architectural Design Decisions](contributor_guide/architecture.md) - 📊 Project Information diff --git a/mkdocs/user_guide/setup_vscode.md b/mkdocs/user_guide/setup_vscode.md index d811c4b74..e8c0ad076 100644 --- a/mkdocs/user_guide/setup_vscode.md +++ b/mkdocs/user_guide/setup_vscode.md @@ -40,7 +40,7 @@ the following benefits: ## Enabling `clangd` -### For a libhal project +### For a libhal library projects If you are contributing to libhal project/repo, then those libraries and demos will already be using `libhal-cmake-util/[^4.0.5]` which will automatically enable the @@ -52,6 +52,13 @@ conan build . And it will be generated. +If you are attempting to do with is a demo or an application you will need to +specify the platform and compiler like usual. + +```bash +conan build . -pr lpc4078 -pr arm-gcc-12.3 +``` + ### For your own project You can either add a `self.requires("libhal-cmake-util/[^4.0.5]")` to your @@ -72,6 +79,12 @@ add_custom_target(copy_compile_commands ALL Now run `conan build .` (where `.` is the path to your project or library) and it should generate the `compile_commands.json` file. +Ensure that you include the necessary profiles added to the build. + +```bash +conan build . -pr stm32f103 -pr arm-gcc-12.3 +``` + ### Refreshing the LSP Now that you should have your `compile_commands.json` in the right location,