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

Restructure content in README.md #257

Open
wmamills opened this issue Oct 10, 2023 · 1 comment
Open

Restructure content in README.md #257

wmamills opened this issue Oct 10, 2023 · 1 comment
Labels

Comments

@wmamills
Copy link
Contributor

The README is a bit log and rambling.

The README is also the main page for the doygen docs which make it one big page also.

Issues/Actions

  • Library categogy data is good but should be in the intro to each section
    • move this content into per module files in doc/ and replace by a table in README.
  • Contributing info does not need to be on the main page, make a page and link it from README
  • Simply build instructions on the main page (README) and move the detailed instructions to a sub-page.
    • Example1: Most people that build for Zephyr will use the Zephyr integration and it will just work. Move the details for the other 5% off the main page.
    • Example2: Build for bare-metal, use an existung generic target on main page. Move instucions on make a new custom target to new page and suggest they carrry that def in their build system instead of pushing to libmetal.
  • (Example2b: ceva CPU port is just generic. Make it easy to support a new CPU that is generic.)
Copy link

This issue has been marked as a stale issue because it has been open (more than) 45 days with no activity.

@github-actions github-actions bot added the Stale label Nov 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant