https://github.com/audiokit/audiokitdevtools
These developer tools are a series of scripts that create the AudioKit documentation, web site materials, and templates for starting to create AudioKit nodes from scratch.
https://github.com/audiokit/audiokitdevtools
Last synced: 10 months ago
JSON representation
These developer tools are a series of scripts that create the AudioKit documentation, web site materials, and templates for starting to create AudioKit nodes from scratch.
- Host: GitHub
- URL: https://github.com/audiokit/audiokitdevtools
- Owner: AudioKit
- Created: 2017-07-12T18:11:11.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2021-05-14T04:14:23.000Z (almost 5 years ago)
- Last Synced: 2025-06-09T08:15:27.366Z (11 months ago)
- Language: HTML
- Homepage:
- Size: 186 KB
- Stars: 18
- Watchers: 10
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
AudioKit Developer Tools
===
These developer tools are a series of scripts intended for developers of AudioKit, not developers who use AudioKit. It contains scripts that create the AudioKit documentation, web site materials, and templates for starting to create AudioKit nodes from scratch.
This repository should be installed parallel to the AudioKit (and optionally, the AudioKit web site) repositories. The scripts should be run from the terminal from the main directory, preceded with "./bin/".
## Instructions for Creating a Soundpipe-powered AudioKit Node
* Run `lua data2yaml.lua` to make a yaml file
* Edit the yaml file to look like others
* Run `./bin/generate_node.rb path-to-folder/file.yaml`
* Add the folder to the Xcode project
* Change the XXXAudioUnit.h to a public header file
* Add to the AudioKit.h file
* Add module.c to AudioKit's Soundpipe folder in Xcode
* Update the config.mk.ak with the new compiled module
* Generate a new soundpipe.h file with `make clean; make CONFIG=config.def.mk.ak` or some shell script
* Copy over the soundpipe.h file (if not part of a shell script)
* Commit the new files
## Be aware of how to code for an open-source framework
* [Tips for Writing a Great iOS Framework](https://medium.com/@samjarman/tips-for-writing-a-great-ios-framework-8cf3452f6c5d#.wzejktd3l)
* [Best practices running an iOS open source project on GitHub](https://www.cocoanetics.com/2014/10/best-practices-running-an-ios-open-source-project-on-github/)