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.

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

Add esp-hal-get-started book content #43

Merged
merged 10 commits into from
Nov 2, 2022
Merged

Add esp-hal-get-started book content #43

merged 10 commits into from
Nov 2, 2022

Conversation

SergioGasquez
Copy link
Member

No description provided.

@SergioGasquez SergioGasquez linked an issue Nov 2, 2022 that may be closed by this pull request
Add esp-hal-get-started book content #42
Closed
@jessebraham
Copy link
Member

Are we not moving forward with the esp-hal-get-started book then?

@SergioGasquez
Copy link
Member Author

Are we not moving forward with the esp-hal-get-started book then?

I spoke with @bjoernQ, and he agreed on moving its content to the main book

@bjoernQ
Copy link
Contributor

bjoernQ commented Nov 2, 2022

Looks good so far but I'd really like to have somewhere mentioned that users can look at the examples in esp-hal to discover the API

jessebraham
jessebraham reviewed Nov 2, 2022
View reviewed changes
Copy link
Member

@jessebraham jessebraham left a comment

Choose a reason for hiding this comment

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

Looks really good overall, just a few comments.

src/writing-your-own-application/no-std-applications/index.md Outdated Show resolved Hide resolved
src/writing-your-own-application/no-std-applications/understanding-esp-template.md Outdated Show resolved Hide resolved
src/writing-your-own-application/no-std-applications/understanding-esp-template.md Outdated Show resolved Hide resolved
src/writing-your-own-application/no-std-applications/understanding-esp-template.md Outdated Show resolved Hide resolved
src/writing-your-own-application/no-std-applications/hello-world.md Outdated Show resolved Hide resolved
src/writing-your-own-application/no-std-applications/blinky.md Outdated Show resolved Hide resolved
@SergioGasquez
Copy link
Member Author

Looks good so far but I'd really like to have somewhere mentioned that users can look at the examples in esp-hal to discover the API

ec9ed16 should resolve this.

@SergioGasquez
Copy link
Member Author

Which approach we should take regarding adding dependencies? Shall we use a fix version number or it will be better to use latest? We are adding esp-println and critical-section and I was dubious wether to add instructions to get latest version or to get a specific one. At the moment, I added instructions that mixi both

@jessebraham
Copy link
Member

I'm not sure I have an answer regarding dependencies at this time, I think what you've done is adequate for now. That conversation can likely be had in an issue or discussion and be dealt with in a separate PR.

jessebraham
jessebraham approved these changes Nov 2, 2022
View reviewed changes
Copy link
Member

@jessebraham jessebraham 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 making those changes, LGTM!

@jessebraham jessebraham merged commit fa9bab9 into main Nov 2, 2022
@SergioGasquez SergioGasquez deleted the feature/esp-hal-book branch November 2, 2022 17:16
SergioGasquez added a commit to SergioGasquez/book that referenced this pull request Nov 3, 2022
@SergioGasquez @jessebraham
Add esp-hal-get-started book content (esp-rs#43)
80ba2a1 
* feat: ✨ Add esp-hal-get-started book content

* docs: 📝 Add references

* docs: 📝 Gramarly suggestions

* docs: 📝 Add note for esp-hal examples

* docs: 📝 Add some clarification on what is working locally

* Update tree view

Co-authored-by: Jesse Braham <[email protected]>

* docs: 📝 Update addressable led note

* docs: 📝 Remove note on espflash behaviour

* Update src/writing-your-own-application/no-std-applications/understanding-esp-template.md

Co-authored-by: Jesse Braham <[email protected]>

* docs: 🎨 Add diverging function reference

Co-authored-by: Jesse Braham <[email protected]>
jessebraham added a commit that referenced this pull request Nov 3, 2022
@SergioGasquez @jessebraham
Second part: book update (#44)
5f5a01c 
* docs: 📝 Add note on naming convention

* docs: 📝 Update WIP note

* docs: 📝 Fix format

* docs: ♻️ Rework installation chapter

* docs: 📝 Add note on esp-idf installation

* docs: 🐛 Fix typo

* docs: 📝 Minor improvements

* Add esp-hal-get-started book content (#43)

* feat: ✨ Add esp-hal-get-started book content

* docs: 📝 Add references

* docs: 📝 Gramarly suggestions

* docs: 📝 Add note for esp-hal examples

* docs: 📝 Add some clarification on what is working locally

* Update tree view

Co-authored-by: Jesse Braham <[email protected]>

* docs: 📝 Update addressable led note

* docs: 📝 Remove note on espflash behaviour

* Update src/writing-your-own-application/no-std-applications/understanding-esp-template.md

Co-authored-by: Jesse Braham <[email protected]>

* docs: 🎨 Add diverging function reference

Co-authored-by: Jesse Braham <[email protected]>

* docs: ✨ Add writting std applications chapter

* docs: 📝 Update tree view and generation promts

* docs: ✨ Add Understanding esp-idf-template section

* docs: 📝 Add main.rs expalanation

* docs: ✨ Add runing the code section

* docs: 🎨 Add esp-idf-hal examples note

* docs: 📝 Add references for template explanation sections

* docs: 📝 Update relevan nostd crates

* Update src/writing-your-own-application/std-applications/index.md

Co-authored-by: Jesse Braham <[email protected]>

* chore: 🎨 Rename installation page

* docs: ✨ Add esp-println

* fix: 🐛 Fix links

* fix: 🐛 Fix links

* docs: 🎨 Clarify `riscv32imc-esp-espidf` usage

Co-authored-by: Jesse Braham <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jessebraham jessebraham jessebraham approved these changes

@bjoernQ bjoernQ Awaiting requested review from bjoernQ

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

Successfully merging this pull request may close these issues.

Add esp-hal-get-started book content
3 participants
@SergioGasquez @jessebraham @bjoernQ