commit c6a4616138874a8d77ee95666d1940bdb5b343fb
parent 9e337141f5cd97709a93c92eccc53d075ebc849b
Author: jatinchowdhury18 <jatinchowdhury18@gmail.com>
Date: Fri, 11 Dec 2020 21:57:52 -0800
Update building and contributing docs (#116)
Co-authored-by: jatinchowdhury18 <jatinchowdhury18@users.noreply.github.com>
Diffstat:
2 files changed, 24 insertions(+), 5 deletions(-)
diff --git a/BUILDING.md b/BUILDING.md
@@ -34,12 +34,25 @@ These can be installed with the following command:
```
sudo apt-get install libasound2-dev libxcursor-dev libxinerama-dev libxrandr-dev freeglut3-dev libjack-jackd2-dev
```
-
-Then to build the plugin (Standalone, VST/ LV2), run
+Depending on your Linux distribution, you may also need to install:
+- freetype
+- libGL
+- libXext
+- libcurl
+- python3 (only if you plan to build LV2)
+
+Then to build the plugin (Standalone, VST3, LV2), run
```
cd Plugin/ && bash build_linux.sh
```
+If you would like to customise which plugin formats are
+built, you may edit line 23 of `build_linux.sh`, to select
+your desired plugin format targets (LV2, VST, VST3, Standalone).
+```bash
+CONFIG=Release make LV2 VST3 Standalone # replace this with a list of your preferred targets
+```
+
Builds can be found in `Builds/LinuxMakefile/build/`.
## Building with the GUI Editor
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -40,9 +40,7 @@ would be most welcome.
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.
+page. Bug fixes and new features are always welcome.
CHOW Tape is built using the [JUCE](https://github.com/juce-framework/JUCE)
framework, and accordingly, we follow the
@@ -53,6 +51,14 @@ 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.
+Once your development environment is set up, we recommend
+creating a feature branch for each change you wish to make.
+This branch should be based off of the `origin/develop`
+branch on GitHub. When you're ready to make a pull request,
+be sure to make `origin/develop` the target branch for your
+pull request as well. Once your pull request has been
+reviewed and all automated checks have passed, your changes
+will be merged!
## Website
