xiph / xiph/opus

Help with documentation

Open
#62 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
3.3k
Forks
808
PR merge metrics
No merged PRs in 30d

Description

Is there a way to figure out all the configurable switches/flags/parameters while compiling the codec?

I ask this because NE10 does not find a mention on the website or the README, but seems to be a useful flag while compiling for mobile platforms that support NEON.

In case there is an automated way of figuring out these switches/flags/parameters, please help me point to it (something like a "opus --help" or "man opus").

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the README and website documentation for codec compilation switches, then determine how users can discover the available flags. Document that discovery method and clarify the NE10/NEON mobile-build option; done when the configurable switches and their lookup process are documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.