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

Documentation #2

Open
calebccff opened this issue Oct 10, 2024 · 1 comment
Open

Documentation #2

calebccff opened this issue Oct 10, 2024 · 1 comment

Comments

@calebccff
Copy link
Member

There is currently zero documentation in this repo, making any contributors go through a whole reverse engineering effort to add support for their device.

As a starting point, I think it would be helpful to at least include the following:

  1. AudioReach background info (what/why/how?)
  2. Links to kernel patch series introducing it (iirc they have some nice ASCII art graphs)
  3. Binary format description + capabilities (what features aren't supported here?)
  4. Explanation of repo structure (why m4? what do each of the include files do? how do they work? what are the .conf files for?)
  5. Brief explanation of m4 syntax and/or links to some good learning resources (expect contributors who have never encountered m4 before)
  6. Example run through section-by-section for typical laptop/mobile configuration (this could also be the place to describe the basic m4 syntax)
  7. Guide for distro packaging
  8. LICENSE file
@konradybcio
Copy link
Member

Linking to this seems useful, too: https://github.com/Audioreach

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

No branches or pull requests

2 participants