AuburnSounds / AuburnSounds/Dplug
Make cheat sheets like for Raylib
- Dominant language
- D
- Stars
- 564
- Forks
- 34
- PR merge metrics
- No merged PRs in 30d
Description
Raylib is superbly documented with the cheat sheets.
Make one for dplug:core, dplug:math
documenting:
- readParam
- logmap
- linmap
- normalizePhase
- ~~_mm_pow_ss/_mm_exp_ss/_mm_pow_ps/_mm_exp_ps~~
- ~~fast_cos/fast_sin/fast_xxx~~
- convertDecibelToLinearGain
- convertLinearGainToDecibel
- convertMIDINoteToFrequency
- convertFrequencyToMIDINote
- using vectors
- using rectangles, inclusing in resizable UI context
- image resizing
- Parameter creation for common types
- `value()` and `valueAtomic()`
- using an atomic
things like that.
Also will be a good way to check if the APIs are good.
Contributor guide
Research direction
Start by reviewing Raylib's cheat sheets, then inspect the dplug:core and dplug:math APIs named in the issue. Done means providing cheat sheets covering the requested parameter, math, vector, rectangle, image, and atomic-value usage examples, while using them to identify API documentation gaps.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100