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

docs: refactor README content #171

Merged
merged 2 commits into from Feb 8, 2019

Conversation

Projects
None yet
2 participants
@deadprogram
Copy link
Member

deadprogram commented Feb 6, 2019

This PR refactors README.md to avoid duplication with information already on the web site, and to reorder to make it easier for new users. It also moves a few details over to the CONTRIBUTING.md document.

docs: refactor README to avoid duplication with information on the we…
…b site, and to reorder to make it easier for new users

Signed-off-by: Ron Evans <ron@hybridgroup.com>
@aykevl
Copy link
Member

aykevl left a comment

This is much better!
See the comments below.

README.md Outdated
garbage collection of some sort). Another difference is that TinyGo uses LLVM
internally instead of emitting C, which hopefully leads to smaller and more
efficient code and certainly leads to more flexibility.
It uses the [Go compiler toolchain](https://golang.org/pkg/go/) alongside [LLVM](http://llvm.org) to provide an alternative way to compile programs written in the Go programming language.

This comment has been minimized.

@aykevl

aykevl Feb 7, 2019

Member

That's only partially true. It does not really reuse anything from the Go compiler toolchain, but reuses the set of libraries used by all the Go tools (in and out of the go command).

README.md Outdated
run on even lower level micros.

Example program (blinky):
Here is an example program that blinks the built-in LED when run directly on an Arduino Uno microcontroller:

This comment has been minimized.

@aykevl

aykevl Feb 7, 2019

Member

This code is actually supported on many different boards, basically all boards that have a built-in LED. What about this?

Here is an example program that blinks the built-in LED when run directly on any supported board with onboard LED:

docs: additional edits for clarity in new README
Signed-off-by: Ron Evans <ron@hybridgroup.com>
@deadprogram

This comment has been minimized.

Copy link
Member Author

deadprogram commented Feb 7, 2019

OK updates pushed.

@deadprogram

This comment has been minimized.

Copy link
Member Author

deadprogram commented Feb 8, 2019

Now merging, thanks for the feedback.

@deadprogram deadprogram merged commit 7657238 into dev Feb 8, 2019

@deadprogram deadprogram deleted the docs/refactor-readme branch Feb 8, 2019

deadprogram added a commit that referenced this pull request Feb 19, 2019

docs: refactor README content (#171)
* docs: refactor README to avoid duplication with information on the web site, and to reorder to make it easier for new users.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.