commit d04acc9b1d921b82ae92868cf3060c7bde3e4e75
parent 59354fbb6beddb440eeb495a9648b96e646cc1d8
Author: Jatin Chowdhury <[email protected]>
Date: Mon, 6 Sep 2021 23:28:51 -0700
Update docs
Diffstat:
2 files changed, 16 insertions(+), 14 deletions(-)
diff --git a/BUILDING.md b/BUILDING.md
@@ -1,7 +1,12 @@
# Instructions For Building
-CHOW Tape is built using [CMake](https://cmake.org), along with the [JUCE](https://github.com/juce-framework/JUCE) framework, and [PluginGUIMagic](https://github.com/ffAudio/PluginGUIMagic)
-for the UI. JUCE and PluginGUIMagic are included in the repository, but CMake must be installed before attempting to build. CHOW Tape also uses the CMake build tool To build from scratch, you must first clone the repository
-and initialize the submodules using the following commands:
+ChowTape is built using [CMake](https://cmake.org),
+along with the [JUCE](https://github.com/juce-framework/JUCE)
+framework, and [PluginGUIMagic](https://github.com/ffAudio/PluginGUIMagic)
+for the UI. JUCE and PluginGUIMagic are included in
+the repository, but CMake must be installed before
+attempting to build. To build from scratch, you must
+first clone the repository and initialize the submodules
+using the following commands:
```bash
# Clone the repository
@@ -31,12 +36,12 @@ cmake -Bbuild-ios -GXcode -DCMAKE_SYSTEM_NAME=iOS \
-DCMAKE_XCODE_ATTRIBUTE_TARGETED_DEVICE_FAMILY="1,2" \
-DCMAKE_XCODE_ATTRIBUTE_ENABLE_BITCODE="NO"
```
-Then, go to the `build-ios/` directory, open the Xcode project,
-and build. Note that you may not need to pass the
-`XCODE_ATTRIBUTE_DEVELOPMENT_TEAM` argument if you're
-building for your own local device, or using the Xcode simulator.
-Alternatively, you could set the development team manually from
-within Xcode.
+Then, go to the `build-ios/` directory, open the Xcode
+project, and build. Note that you may not need to pass
+the `XCODE_ATTRIBUTE_DEVELOPMENT_TEAM` argument if
+you're building for your own local device, or using
+the Xcode simulator. Alternatively, you could set the
+development team manually from within Xcode.
## Linux Dependencies
The Linux build utilises the following dependencies:
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-# Contributing to CHOW Tape
+# Contributing to ChowTape
The goal of this project is to create a high-quality,
open-source tape emulation plugin. Here's how you can
@@ -33,9 +33,6 @@ For more information on contributing presets, see the
If you've been using the plugin for a while and are pretty
familiar with it, please consider contributing to the plugin
[documentation](https://ccrma.stanford.edu/~jatin/chowdsp/Products/ChowTapeManual.pdf).
-Additionally, if someone would want to make a YouTube video
-giving a demo or a walkthrough of the plugin features, that
-would be most welcome.
## Plugin Development
@@ -45,7 +42,7 @@ start by checking out the
[issues](https://github.com/jatinchowdhury18/AnalogTapeModel/issues)
page. Bug fixes and new features are always welcome.
-CHOW Tape is built using the [JUCE](https://github.com/juce-framework/JUCE)
+ChowTape 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
