Fix some spelling errors

tobanteAudio · Apr 30, 2020 · e0d4de5 · e0d4de5
1 parent 23ae35c
commit e0d4de5
Show file tree

Hide file tree

Showing 15 changed files with 85 additions and 20 deletions.
diff --git a/.spelling b/.spelling
@@ -0,0 +1,63 @@
+# markdown-spellcheck spelling configuration file
+# Format - lines beginning # are comments
+# global dictionary is at the start, file overrides afterwards
+# one word per line, to define a file override use ' - filename'
+# where filename is relative to this configuration file
+GitLab
+modEQ
+macOS
+JUCE
+Appveyor
+Xorg
+pluginval
+constexpr
+noexcept
+const
+TheCherno
+CppCon
+BoostCon
+ACCU
+CppWeekly
+XCode
+CLion
+gcc
+gcov
+lcov
+llvm-profdata
+llvm-cov
+ASAN
+UBSAN
+MSAN
+TSAN
+MSVC
+32bit
+Projucer
+submodules
+Doxygen
+readthedocs
+AudioPluginHost
+CMake
+BSDs
+AudioUnit
+VST
+FreeCAD
+premade
+SFML
+IMGUI
+DSP
+Catch2
+Valgrind
+CTest
+tobanteAudio
+Vulkan
+AudioProcessor
+ValueTree
+Tracktion
+DAW
+Foleys
+Arduino
+GLEW
+Combobox
+LookAndFeel
+ - chapters/ci.md
+TLDR
diff --git a/chapters/ci.md b/chapters/ci.md
@@ -1,5 +1,5 @@
 # Continuous Integration
 
-Explaining the concepts of `continuous integration` and `continuous deployment` is far out of scope for this document, but TLDR: CI helps you find problems in your code faster. Every time you push to your version control server of choice (e.g. GitHub or GitLab) builds on various platforms start up. For example in my plugin project modEQ, I have builds for Windows, macOS & Linux. Since all of the platforms are using different compilers I get different warnings on each. Fixing all those little things as you go will save you a lot of time compared to developing exclusively on one platform and then trying to release it for a additional platform at the end.
+Explaining the concepts of `continuous integration` and `continuous deployment` is far out of scope for this document, but TLDR: CI helps you find problems in your code faster. Every time you push to your version control server of choice (e.g. GitHub or GitLab) builds on various platforms start up. For example in my plug-in project modEQ, I have builds for Windows, macOS & Linux. Since all of the platforms are using different compilers I get different warnings on each. Fixing all those little things as you go will save you a lot of time compared to developing exclusively on one platform and then trying to release it for a additional platform at the end.
 
 There are many CI services online for free if your project is publicly available on GitHub or other platforms. I will focus on `travis-ci` and `appveyor` because those to combined will cover all desktop platforms JUCE supports (Windows, macOS & Linux).
diff --git a/chapters/ci/publish.md b/chapters/ci/publish.md
@@ -7,4 +7,4 @@
 ## Deploy
 
 - docs
-- app/plugin
+- app/plug-in
diff --git a/chapters/ci/travis.md b/chapters/ci/travis.md
@@ -2,7 +2,7 @@
 
 - basics
 - install deps
- - Linux fake xorg
+ - Linux fake Xorg
 - platform matrix
 - push to gh-pages
 - run pluginval

diff --git a/chapters/cpp/tools.md b/chapters/cpp/tools.md
@@ -29,7 +29,7 @@
 
 ## compiler-explorer
 
-Online compiler. Great for testing small code snippets. Does not currently have `JUCE` installed unfortunatly.
+Online compiler. Great for testing small code snippets. Does not currently have `JUCE` installed unfortunately.
 
 ## coverage
 

diff --git a/chapters/getting_started/create_project.md b/chapters/getting_started/create_project.md
@@ -5,7 +5,7 @@
 - ConsoleApp
 - GuiApp
 - AudioApp
-- Plugin
+- Plug-in
 
 ## Project management
 

diff --git a/chapters/setup/other_libraries.md b/chapters/setup/other_libraries.md
@@ -10,7 +10,7 @@ If you have been programming with C++ for a while, you probably heard of Qt. It'
 
 The goal of Qt is to do it all. It runs on almost every platform including BSDs and embedded platforms. Because of this the whole framework is huge. While JUCE is around a couple of hundred megabytes, Qt is more in the range of a couple gigabytes.
 
-Qt is also not really designed to help you write audio applications. There is no easy way to wrap a Qt application in an AudioUnit or VST plugin for example.
+Qt is also not really designed to help you write audio applications. There is no easy way to wrap a Qt application in an AudioUnit or VST plug-in for example.
 
 If your goal is to write a desktop application in the style of Gimp, FreeCAD or Blender and you need a lot of premade desktop widgets, Qt is probably the way to go.
 

diff --git a/chapters/setup/resources.md b/chapters/setup/resources.md
@@ -22,7 +22,7 @@ The JUCE team has their own [YouTube channel](https://www.youtube.com/channel/UC
 
 ### The Audio Programmer
 
-`The Audio Programmer` is a YouTube channel which almost only does JUCE related development tutorials. He has videos for the basics on getting up & running with the library, introduction to `Components`, an introduction to audio plugin development and interviews with people working in the audio developer industry. Each video is `~20-60min` long.
+`The Audio Programmer` is a YouTube channel which almost only does JUCE related development tutorials. He has videos for the basics on getting up & running with the library, introduction to `Components`, an introduction to audio plug-in development and interviews with people working in the audio developer industry. Each video is `~20-60min` long.
 
 If you are new to C++ and audio this is a create place to start.
 

diff --git a/chapters/setup/why_juce.md b/chapters/setup/why_juce.md
@@ -6,7 +6,7 @@ Long story short, JUCE is a library which solves many common problems a develope
 
 ### Audio
 
-- Wraps all common plugin types.
+- Wraps all common plug-in types.
 - Basic DSP & Analysis
 - Vector instructions for x86 and ARM
 

diff --git a/chapters/testing/pluginval.md b/chapters/testing/pluginval.md
@@ -1,8 +1,10 @@
-# PluginVal
+# pluginval
 
-- Download or build from source
-- Run with maximum strictness (10)
-- Test AU & VST
+The pluginval team describes there software as:
+
+```text
+pluginval is a cross-platform plugin validator and tester application. It is designed to be used by both plugin and host developers to ensure stability and compatibility between plugins and hosts.
+```
 
 ## Install
 

diff --git a/chapters/testing/unit_test.md b/chapters/testing/unit_test.md
@@ -8,4 +8,4 @@
 
 ## JUCE Unit Tests
 
-- How to run them in a plugin build
+- How to run them in a plug-in build
diff --git a/chapters/wish_list.md b/chapters/wish_list.md
@@ -1,9 +1,9 @@
 # My wish list for JUCE
 
 - FreeBSD support (Working on it, see [tobanteAudio/juce-freebsd-example](https://github.com/tobanteAudio/juce-freebsd-example))
-- Build system (solved in JUCE6)
+- Build system (solved in JUCE version 6)
  - CMake
  - Multiple targets in one project
 - Better Graphics API integration
- - Metal (coming in JUCE6)
+ - Metal (coming in JUCE version 6)
  - Vulkan
diff --git a/chapters/working_with_juce/dsp.md b/chapters/working_with_juce/dsp.md
@@ -4,7 +4,7 @@
  - Gain example
  - Compressor example
 - AudioProcessor
-- Plugins
+- Plug-ins
  - VST/AU
 - ValueTree
  - Parameters

diff --git a/chapters/working_with_juce/juce_modules.md b/chapters/working_with_juce/juce_modules.md
@@ -1,8 +1,8 @@
 # JUCE Modules
 
-## 3rd Party Modules
+## Third Party Modules
 
-Small and definitely not complete list of 3rd party JUCE modules.
+Small and definitely not complete list of Third party JUCE modules.
 
 | Name | License | Description | Comment |
 | --------------------------------------------------------------------- | -------------- | -------------------------------------------------------------------- | --------------------------- |

diff --git a/chapters/working_with_juce/misc.md b/chapters/working_with_juce/misc.md
@@ -1,6 +1,6 @@
 # Misc
 
-## MVC
+## Model View Controller
 
 - Why
 - Example
@@ -13,7 +13,7 @@
 
 ## Network IO
 
-- OSC
+- Open Sound Control
  - Arduino
 
 ## OpenGL