Skip to content

Update README.md #1152

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 2 commits into from
Feb 7, 2025
Merged

Update README.md #1152

merged 2 commits into from
Feb 7, 2025

Conversation

vinchatl
Copy link
Contributor

@vinchatl vinchatl commented Feb 2, 2025

Summary of changes:

  • Add a diagram to better explain how raw SVDs, patches and fields description are used to create the stm32 crates
  • Remove duplicate section
  • Other minor changes

Some sections in ## Helping feel redundant with what's written in CONTRIBUTING.md (which is a lot more detailed), do you think a link to this file could be better ?

@burrbull
Copy link
Member

burrbull commented Feb 2, 2025 •
edited
Loading

There are devices/patches, devices/fields and devices/collect. Last dir is for collecting in arrays, clusters and derives to minimize duplications.

Ideally if we comment out fields/* and collect/* patches it should be valid SVD. Same if we comment out only collect/* patches it still should be valid SVD.

@vinchatl
Copy link
Contributor Author

vinchatl commented Feb 4, 2025

Are you suggesting to add collect to the diagram and to the ## Helping section ?

@burrbull
Copy link
Member

burrbull commented Feb 5, 2025

Are you suggesting to add collect to the diagram and to the ## Helping section ?

Yes.

@burrbull
Copy link
Member

burrbull commented Feb 7, 2025

It does not fit by width
https://github.com/stm32-rs/stm32-rs/blob/4188594024adc5a290fae5d25bc8951d9472fe5e/README.md

@vinchatl
Copy link
Contributor Author

vinchatl commented Feb 7, 2025

Didn't see that, I'll fix it. Other than that, are you ok on the content ?

@burrbull burrbull enabled auto-merge February 7, 2025 20:12
@burrbull burrbull added this pull request to the merge queue Feb 7, 2025
@vinchatl
Copy link
Contributor Author

vinchatl commented Feb 7, 2025

It seems it still doesn't fit the renderer on the main page: https://github.com/vinchatl/stm32-rs/tree/update_readme

Merged via the queue into stm32-rs:master with commit c2d5574 Feb 7, 2025
22 checks passed
@vinchatl vinchatl deleted the update_readme branch February 7, 2025 20:22
@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 8, 2025

Memory map comparison

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@burrbull burrbull burrbull approved these changes

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

Successfully merging this pull request may close these issues.
2 participants
@vinchatl @burrbull
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy