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

Added index to an overwhelmingly large README.md #1

Merged
merged 1 commit into from
Feb 7, 2023

Conversation

mardab
Copy link
Contributor

@mardab mardab commented Feb 7, 2023

Hello,

I find your port of NuttX to Cortex-A53+GICv2 invaluably amazing, which is sadly what I cannot say about README file of this project.

It is understandable to want to include every piece of information needed to work with this port, but at over 11 thousand lines, about half of them being exemplary log output, this approaches an Applicaton Note or Datasheet territory.

Without being sure what should be left in README and what should be moved to a different document (perhaps a Github-provided project wiki?) for full readability, the least I can do is to add an index to every part of README, which as you can see is over 100 entries with indentation inferred from content.

Should you accept this improvement even partially, I will be looking forward to provide "real" contributions to this fascinating project.

Sincerely,
Marcin Dąbrowski

@lupyuen lupyuen merged commit 5490c62 into lupyuen:main Feb 7, 2023
@lupyuen
Copy link
Owner

lupyuen commented Feb 7, 2023

Thanks! Really appreciate it, I'll update the Table of Contents for future updates. Please check out the articles, I think they might be better for collaboration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants