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.

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

doc: Add VSCode and Cmake setup guide #45

Merged
merged 1 commit into from
Oct 20, 2021
Merged

Conversation

elsalahy
Copy link
Contributor

Summary

Adds documentation on how to setup CMake using VScode CMake Tools extension.
Clsose #16

Changes

  • Add docs and images on how to use CMake Tools VSCode extension.

Notes for Reviewers

...

Checklist

  • Scope: The referenced issue is addressed, there are no unrelated changes.
  • Run Locally: Verified that the docs build using make server, posted screenshots, verified external links.
  • New Features Marked: Documentation for new features is marked using the new-in-version shortcode, according to the guidelines in CONTRIBUTING.
  • Style Guidelines: Documentation obeys style guidelines in CONTRIBUTING.
  • Commits: Commit messages follow guidelines in CONTRIBUTING, there are no fixup commits left.

@elsalahy elsalahy self-assigned this Oct 18, 2021
@elsalahy
Copy link
Contributor Author

@HeadBoffin does this PR cover your request?

nejraselimovic
nejraselimovic previously approved these changes Oct 20, 2021

You can adjust [CMake settings](https://github.com/microsoft/vscode-cmake-tools/blob/develop/docs/cmake-settings.md#cmake-settings) according to your environment.

For example, In Windows, you can adjust the generator to `MinGW Makefiles` instead of `Ninja`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For example, In Windows, you can adjust the generator to `MinGW Makefiles` instead of `Ninja`
For example, In Windows, you can adjust the generator to `MinGW Makefiles` instead of `Ninja`:

"cmake.generator":"MinGW Makefiles",
```

You can also adjust the `TARGET_APP` to `basic_lorawan` or any other preferred application.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can also adjust the `TARGET_APP` to `basic_lorawan` or any other preferred application.
You can also adjust the `TARGET_APP` to `basic_lorawan` or any other preferred application:


```
"TARGET_APP":"basic_lorawan",
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add a blank line after this code block

Comment on lines 66 to 68
Finally, you can invoke the following commands from VSCode Command Palette:

`Cmake: Configure` followed by `Cmake: Build`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Finally, you can invoke the following commands from VSCode Command Palette:
`Cmake: Configure` followed by `Cmake: Build`.
Finally, you can invoke the following commands from VSCode Command Palette with `Cmake: Configure` followed by `Cmake: Build`.

@elsalahy
Copy link
Contributor Author

Thanks @nejraselimovic for the quick reviews, much appreciated, can you please take another look.

@elsalahy elsalahy merged commit 984ea1e into master Oct 20, 2021
@adriansmares adriansmares deleted the docs/cmake-vscode branch August 12, 2022 12:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants