Skip to content

Add documentation on how to enable bare-metal #964

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

Merged
merged 3 commits into from
Mar 1, 2019

Conversation

aashishc1988
Copy link
Contributor

Add documentation that guides the user on how to enable bare-metal

@theotherjimmy
Copy link
Contributor

Requires ARMmbed/mbed-os#9800

Amanda Butler added 2 commits February 26, 2019 11:56
Edit section about migrating to Mbed OS bare metal, mostly for consistent branding.
Add link to earlier section for best linking practices.
Copy link
Contributor

@AnotherButler AnotherButler left a comment

Choose a reason for hiding this comment

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

Thanks for the PR 👍

Copy link
Member

@bulislaw bulislaw left a comment

Choose a reason for hiding this comment

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

I think we should introduce this not only as a migration option, but add a section describing differences between the two. Here we could add the mode description/differences https://os.mbed.com/docs/mbed-os/v5.11/reference/mbed-os-fundamentals.html and link it to here https://os.mbed.com/docs/mbed-os/v5.11/tools/working-with-mbed-cli.html after we add a section how to use it.

@SenRamakri
Copy link
Contributor

@bulislaw - A high-level introduction/marketing content about bare-metal is in works from Mohit. He will be working with Amanda to bring that as a PR. It will also capture the differences from MbedOS5.

@AnotherButler
Copy link
Contributor

@bulislaw Have your concerns been addressed (at least until we receive the introduction and comparison)?

@AnotherButler AnotherButler merged commit 9f509b4 into ARMmbed:development Mar 1, 2019

### Enabling Mbed OS bare metal

Enabling the Mbed OS bare metal profile allows you to build Mbed OS without an RTOS. To enable it, you have to complete the [migration to Mbed OS 5](#migrating-to-mbed-os-5). Once the migration is complete, you can enable Mbed OS bare metal by creating an `mbed-app.json` with the following contents:
Copy link
Member

@thegecko thegecko Mar 14, 2019

Choose a reason for hiding this comment

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

@AnotherButler isn't this file called mbed_app.json? (with an underscore)

Copy link
Contributor

Choose a reason for hiding this comment

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

I'll fix that

Copy link
Member

Choose a reason for hiding this comment

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

hooray!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants