commit fcbb5f18326d81f519a4629cc3ce8dfe83971129
parent 00b0e80d6c8939cccbf6e90d53e092a8a11e7bd3
Author: jatinchowdhury18 <[email protected]>
Date: Mon, 19 Apr 2021 23:53:34 -0700
Update documentation
Diffstat:
6 files changed, 21 insertions(+), 20 deletions(-)
diff --git a/BUILDING.md b/BUILDING.md
@@ -17,7 +17,6 @@ git submodule update --init --recursive
Next you can generate the builds with CMake:
```bash
-cd Plugin/
cmake -Bbuild
cmake --build build/ --config Release
```
@@ -57,7 +56,9 @@ Depending on your Linux distribution, you may also need to install:
- libGL
- libXext
- libcurl
-- python3 (only if you plan to build LV2)
## 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. In `Plugin/CMakeLists.txt`, set `FOLEYS_SHOW_GUI_EDITOR_PALLETTE` equal to 1.
+If you need to make changes to the GUI, you can build
+the plugin with Foley's Magic Editor attached. In
+`Plugin/modules/CMakeLists.txt`, set
+`FOLEYS_SHOW_GUI_EDITOR_PALLETTE` equal to 1.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,7 @@
All notable changes to this project will be documented in
this file.
-## [2.8.0] - Unreleased
+## [2.8.0] - 2021-04-20
- Added support for iOS (AUv3) and Apple Silicon.
- Added Azimuth parameter for playhead loss controls.
- Added Variance and Drift parameters for Wow control.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -11,7 +11,10 @@ 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
+that can all have different behavior, triggering different bugs.
+Testing with the [Nightly Builds](https://chowdsp.com/nightly.html#tape)
+is especially appreciated, to help catch bugs before they make
+it into an official release. 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!
@@ -60,12 +63,6 @@ pull request as well. Once your pull request has been
reviewed and all automated checks have passed, your changes
will be merged!
-## 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
diff --git a/Manual/ChowTapeManual.pdf b/Manual/ChowTapeManual.pdf
Binary files differ.
diff --git a/Manual/ChowTapeManual.tex b/Manual/ChowTapeManual.tex
@@ -33,7 +33,8 @@ If you would like to try the latest changes (unstable), you can
download the latest \href{https://chowdsp.com/nightly.html}{Nightly build}.
It is also possible to compile the plugin
\href{https://github.com/jatinchowdhury18/AnalogTapeModel/blob/master/BUILDING.md}{from the source code}.
-ChowTape for iOS can be downloaded from the \href{@TODO}{App Store}.
+ChowTape for iOS can be downloaded from the
+\href{https://apps.apple.com/us/app/chowtapemodel/id1557806564}{App Store}.
\begin{figure}[ht]
\center
@@ -82,7 +83,7 @@ parameters.
\begin{figure}[ht]
\center
\includegraphics[height=0.32\paperheight]{../Plugin/Screenshots/Filters.png}
- \caption{\label{h_bias}{\it Input filter controls}}
+ \caption{\label{h_inputs}{\it Input filter controls}}
\end{figure}
\subsubsection{Input Filter Controls}
diff --git a/README.md b/README.md
@@ -13,6 +13,7 @@ at Stanford University (CCRMA).
### Quick Links
- [Latest Release](https://chowdsp.com/products.html#tape)
+- [ChowTape for iOS](https://apps.apple.com/us/app/chowtapemodel/id1557806564)
- [Nightly Builds](https://chowdsp.com/nightly.html#tape)
- [User Manual](https://chowdsp.com/manuals/ChowTapeManual.pdf)
@@ -34,22 +35,23 @@ CHOW Tape is currently available in the following formats:
- VST
- VST3
- AU
+ - AUv3
- LV2
- Standalone plugin
## Installation
-Download the latest release
-[here](https://chowdsp.com/products.html#tape).
+The latest release for desktop can be downloaded from
+[our website](https://chowdsp.com/products.html#tape).
+ChowTape for iOS can be downloaded from the
+[app store](https://apps.apple.com/us/app/chowtapemodel/id1557806564).
If you would like to try the nightly builds (potentially unstable),
-see [here](https://chowdsp.com/nightly.html#tape).
-If you need Linux builds, or if you prefer to build the plugin for yourself,
+see [the Nightly Builds page](https://chowdsp.com/nightly.html#tape).
+If you prefer to build the plugin for yourself,
please see the [building instructions](https://github.com/jatinchowdhury18/AnalogTapeModel/blob/master/BUILDING.md).
-Alternatively, Linux users may download builds from the
+Linux users may also download builds from the
[Open Build Service](https://build.opensuse.org/package/show/home:kill_it:JUCE/CHOWTapeModel).
-**Note: If you have a computer with Applie Silicon, please try the [experimental build](https://chowdsp.com/nightly.html#tape)! Please note your experiences using the plugin on Apple Silicon in this [issue](https://github.com/jatinchowdhury18/AnalogTapeModel/issues/124).**
-
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).
