Skip to content

update readme - #21

Merged
Woyten merged 1 commit into
masterfrom
update-readme
Mar 19, 2018
Merged

update readme#21
Woyten merged 1 commit into
masterfrom
update-readme

Conversation

@bradjc

@bradjc bradjc commented Mar 17, 2018

Copy link
Copy Markdown
Contributor

Current directions don't work.

Comment thread README.md Outdated

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

@Woyten Woyten Mar 17, 2018

Copy link
Copy Markdown
Contributor

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.

Comment thread README.md Outdated
`xargo build --target thumbv7em-tock-eabi`
### Note! Do not use rustc-1.26!

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

Copy link
Copy Markdown
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 left a comment

Copy link
Copy Markdown
Contributor

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.

Comment thread README.md Outdated

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

Copy link
Copy Markdown
Contributor

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

Comment thread 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
Copy Markdown
Contributor

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.

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

Copy link
Copy Markdown
Contributor

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

bradjc commented Mar 18, 2018

Copy link
Copy Markdown
Contributor Author

Updated now that #18 is merged.

@Woyten Woyten left a comment

Copy link
Copy Markdown
Contributor

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

Woyten commented Mar 23, 2018

Copy link
Copy Markdown
Contributor

@bradjc Can this branch be deleted?

@alevy

alevy commented Mar 23, 2018

Copy link
Copy Markdown
Member

@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

Woyten commented Mar 23, 2018

Copy link
Copy Markdown
Contributor

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants