commit 508bb8249ed85dc1191b05e60c389cfd72af533e
parent e56347476b7bde1566d1329ed8878bf67381c66c
Author: jatinchowdhury18 <jatinchowdhury18@users.noreply.github.com>
Date: Sun, 21 Jun 2020 19:46:48 -0700
Add building/contributing docs
Diffstat:
| A | BUILDING.md | | | 28 | ++++++++++++++++++++++++++++ |
| A | CONTRIBUTING.md | | | 92 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| M | README.md | | | 31 | +++++++------------------------ |
3 files changed, 127 insertions(+), 24 deletions(-)
diff --git a/BUILDING.md b/BUILDING.md
@@ -0,0 +1,28 @@
+# Instructions For Building
+
+CHOW Tape is built using the [JUCE](https://github.com/juce-framework/JUCE) framework, with [PluginGUIMagic](https://github.com/ffAudio/PluginGUIMagic)
+for the UI. To build from scratch, use the following steps:
+
+1. Run the following commands:
+ ```bash
+ # Clone the repository
+ git clone --recursive https://github.com/jatinchowdhury18/AnalogTapeModel.git
+
+ # Enter the repository
+ cd AnalogTapeModel/Plugin
+
+ # Initialize JUCE submodule
+ git submodule update --init --recursive
+ ```
+2. Navigate to `JUCE/extras/Projucer/Builds/`
+3. Build the Projucer using XCode (Mac), Visual Studio (Windows), or Makefile (Linux)
+4. From the Projucer, open CHOWTapeModel.jucer
+5. Select "Save and open in IDE"
+6. Build CHOW Tape
+
+### Building with the GUI Editor
+
+If you need to make changes to the GUI, you can build the
+plugin with Foley's Magic Editor attached. From the Projucer,
+navigate to `modules -> foleys_gui_magic`, and enable
+`FOLEYS_SHOW_GUI_EDITOR_PALLETTE`.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,92 @@
+# Contributing to CHOW Tape
+
+The goal of this project is to create a high-quality,
+open source tape emulation plugin. Here's how you can
+help:
+
+
+## Testing
+
+The easiest way to contribute is to simply use the plugin!
+All software has bugs, so the more folks using the software,
+the quicker bugs will be found and fixed! For audio plugins
+in particular, there are different DAWs, versions, etc,
+that can all have different behavior, triggering different bugs. The
+[issues](https://github.com/jatinchowdhury18/AnalogTapeModel/issues)
+page can be used for reporting bugs or posting feature requests.
+All feedback is useful and most welcome!
+
+
+## Documentation
+
+If you've been using the plugin for a while and are pretty
+familiar with it, please consider contributing to the plugin
+[documentation](https://github.com/jatinchowdhury18/AnalogTapeModel/wiki/User-Manual).
+Additionally, if someone would want to make a YouTube video
+giving a demo or a walkthrough of the plugin features, that
+would most welcome.
+
+
+## Presets
+
+If you have a favorite setting for the plugin, consider
+adding it as a preset so other users can try it as well!
+For more information on contributing presets, see the
+[presets issue](https://github.com/jatinchowdhury18/AnalogTapeModel/issues/30).
+
+
+## Plugin Development
+
+If you'd like to contribute to the development of the plugin,
+start by checking out the
+[issues](https://github.com/jatinchowdhury18/AnalogTapeModel/issues)
+page. Bug fixes and new features are always welcome. Simply
+make a pull request: once your code has been reviewed and all
+checks have passed, your changes will be merged.
+
+CHOW Tape is built using the [JUCE](https://github.com/juce-framework/JUCE)
+framework, and accordingly, we follow the
+[JUCE coding standards](https://juce.com/discover/stories/coding-standards).
+For information on getting started with development, please see the
+[building](https://github.com/jatinchowdhury18/AnalogTapeModel/blob/master/BUILDING.md)
+page. If you plan to implement a new feature, please create a
+[feature request](https://github.com/jatinchowdhury18/AnalogTapeModel/issues/new?assignees=jatinchowdhury18&labels=enhancement&template=feature_request.md&title=%5BFEATURE%5D)
+first, so the feature can be discussed by the community.
+
+
+## Design
+
+If you have experience with graphic design (or want to gain experience),
+contributions to the design of the plugin are welcome. The UI is mostly
+built using [PluginGUIMagic](https://github.com/ffAudio/PluginGUIMagic),
+so the design can be altered with minimal changes to the codebase.
+For more information, please [contact](#Contact) me.
+
+
+## Website
+
+CHOW Tape does not currently have it's own website. If you want to help
+create a website for the plugin, please [contact](#Contact) me.
+
+
+## Donating
+
+If you feel so inclined, feel free to
+[buy me a drink](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=93S67ZSKMBG68&source=url).
+Note that I am making this software purely out of enjoyment,
+and I certainly do not expect any monetary compensation. Also
+note that donating will not give you any priority in determining
+which bugs are fixed first, or which features are implemented.
+
+
+## Sharing
+
+Finally, if you enjoy using this plugin, feel free to share with
+others!
+
+
+---
+## Contact
+
+If you have questions, or want more information, please
+contact me via [email](mailto:jatin@ccrma.stanford.edu).
diff --git a/README.md b/README.md
@@ -39,36 +39,19 @@ If you would like to try the most recent builds (potentially unstable),
see [here](https://github.com/jatinchowdhury18/AnalogTapeModel/tree/master/Plugin/Bin).
If you need a build that is compatible with Mac OS Catalina, try
[this link](https://www.dropbox.com/s/n14b1ju8kofp71v/CHOWTape.zip).
+If you prefer to build the plugin for yourself, please see the
+[building instructions](https://github.com/jatinchowdhury18/AnalogTapeModel/blob/master/BUILDING.md).
Note for FL Studio users: If you're experiencing pops and click while using
the plugin, try enabling the "used fixed size buffers" setting. For more
information, see this [issue](https://github.com/jatinchowdhury18/AnalogTapeModel/issues/17#issuecomment-640199581).
-### Instructions For Building
-If you would like to build CHOW for yourself, use the following steps.
+## Contributing
-- Install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
-- Run the following git commands:
- ```bash
- # Clone the repository
- git clone --recursive https://github.com/jatinchowdhury18/AnalogTapeModel.git
-
- # Enter the repository
- cd AnalogTapeModel/Plugin
-
- # Initialize JUCE submodule
- git submodule update --init --recursive
- ```
-- Navigate to "JUCE/extras/Projucer/Builds/"
-- Build the Projucer using XCode (Mac), Visual Studio (Windows), or Makefile (Linux)
-- From the Projucer, open CHOWTapeModel.jucer
-- From the "File" menu, open "Global Paths..."
- - Set "Path To JUCE" to "...\Plugin\JUCE"
- - Set "JUCE Modules" to "...\Plugin\JUCE\modules"
- - Set "VST (Legacy) SDK" to "...\Plugin\JUCE\VST2_SDK"
- - Close "Global Paths" window
-- Select "Save and open in IDE"
-- Build CHOW Tape
+Contributions are most welcome! There are many ways to contribute to this
+project, for both programmers and non-programmers. For more information,
+see the
+[contributing guidelines](https://github.com/jatinchowdhury18/AnalogTapeModel/blob/master/CONTRIBUTING.md).
## License
CHOW Tape is licensed under the GNU General Public License agreement. Enjoy!
