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

Update and simplify installation instructions for linux #456

Merged
merged 1 commit into from
Sep 2, 2020

Conversation

rleh
Copy link
Member

@rleh rleh commented Sep 1, 2020

No description provided.

Copy link
Member

@salkinium salkinium left a comment

Choose a reason for hiding this comment

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

The old instructions were structured according to the target, since the user does not need to install avr-gcc for ARM or arm-gcc for avr etc. Your changes now squash everything together, is this a good idea?

docs/src/guide/installation.md Outdated Show resolved Hide resolved
docs/src/guide/installation.md Outdated Show resolved Hide resolved
docs/src/guide/installation.md Outdated Show resolved Hide resolved
docs/src/guide/installation.md Show resolved Hide resolved
@salkinium
Copy link
Member

Also while we're here, lets change the order of the guide and place Installation first: https://github.com/modm-io/modm/blob/develop/docs/mkdocs.yml#L72-L73

@salkinium
Copy link
Member

Your changes now squash everything together

Maybe we can add a TL;DR: installation two-liner right at the beginning for the most likely use-case, which is ARM Cortex-M development on Ubuntu 20.04 LTS? Then after that a more detailed view?

@rleh
Copy link
Member Author

rleh commented Sep 1, 2020

Maybe we can add a TL;DR

Exactly this was my motivation to bring install all packages with a single apt (& one pip) command.

Then after that a more detailed view?

Done in the warnings.

Copy link
Member

@salkinium salkinium left a comment

Choose a reason for hiding this comment

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

Ok, let's go with this!

@salkinium salkinium merged commit b555133 into modm-io:develop Sep 2, 2020
@rleh rleh deleted the update-installation-ubuntu branch September 2, 2020 12:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants