Added index to an overwhelmingly large README.md #1
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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