Skip to content

update readme #21

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

Jump to bottom
Merged
merged 1 commit into from
Mar 19, 2018
Merged

update readme #21

merged 1 commit into from
Mar 19, 2018

Conversation

bradjc
Copy link
Contributor

@bradjc bradjc commented Mar 17, 2018

Current directions don't work.

Woyten
Woyten reviewed Mar 17, 2018
View reviewed changes
README.md Outdated
@@ -6,22 +6,19 @@ Rust userland library for Tock (WIP)

This project is nascent and still under heavy development, but first steps:

1. Ensure you have a working toolchain available:
```bash
./build_examples.sh
Copy link
Contributor

@Woyten Woyten Mar 17, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Technically, this step is not required. The purpose of build_examples.sh is to be run by Travis CI in order to make sure that all examples compile.

Woyten
Woyten reviewed Mar 17, 2018
View reviewed changes
README.md Outdated

For some reason it does not generate binaries for example apps.
Copy link
Contributor

Choose a reason for hiding this comment

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

#18 will enforce the nightly-2018-03-06 toolchain which seems to work.

torfmaster
torfmaster reviewed Mar 17, 2018
View reviewed changes
Copy link
Collaborator

@torfmaster torfmaster 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 changes! I added some ideas how one could make the instructions more precise.

README.md Outdated
@@ -6,22 +6,19 @@ Rust userland library for Tock (WIP)

This project is nascent and still under heavy development, but first steps:

1. Ensure you have a working toolchain available:
```bash
./build_examples.sh
Copy link
Collaborator

Choose a reason for hiding this comment

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

./run_example.sh also builds the examples

README.md Outdated
4. Now you should be able to build with:

`xargo build --target thumbv7em-tock-eabi`
### Note! Do not use rustc-1.26!
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think you should not fix the version of the compiler at all. This should be managed by the toolchain file.

README.md Outdated
2. Get a copy of this toolchain, in this repo's root:
```bash
./run_example.sh blink
```
Copy link
Collaborator

Choose a reason for hiding this comment

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

One could notice here that due to behavior of the tockloader the parameters passed to tockloader in the run_example script only work for the nrf52dk, currently. At least as far as I can judge.

@bradjc
Copy link
Contributor Author

bradjc commented Mar 18, 2018

Updated now that #18 is merged.

Woyten
Woyten approved these changes Mar 18, 2018
View reviewed changes
Copy link
Contributor

@Woyten Woyten left a comment

Choose a reason for hiding this comment

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

LGTM. If nobody has anything to add, I will merge this very soon.

@Woyten Woyten merged commit 4b0af4d into master Mar 19, 2018
@Woyten
Copy link
Contributor

Woyten commented Mar 23, 2018

@bradjc Can this branch be deleted?

@alevy
Copy link
Member

alevy commented Mar 23, 2018

@Woyten I think it's fine to always delete branches for merged branches

(And generally I like the idea of not using branches on the main repo for PRs, but I've been loosing that battle... :/ )

@Woyten
Copy link
Contributor

Woyten commented Mar 23, 2018

I totally agree. So I'll do what needs to be done! 😉

@Woyten Woyten deleted the update-readme branch March 23, 2018 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@torfmaster torfmaster torfmaster left review comments

@Woyten Woyten Woyten approved these changes

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@bradjc @Woyten @alevy @torfmaster