diff --git a/README.md b/README.md index 1f8febb..2c9bc2e 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,81 @@ # Crille Bass Strip -A VST3 bass effects plugin built with JUCE and C++. +Crille Bass Strip är ett VST3-plugin för bas, utvecklat i C++ med JUCE. -## Signal Chain +## Signalkedja Noise Gate → Compressor → Distortion → EQ → Output -## Requirements +## Plattformar -- CMake -- Git -- Ninja -- C++ compiler -- JUCE is downloaded automatically by CMake +Pluginet kan byggas på: + +- macOS +- Windows + +## Pluginformat + +För närvarande stöds: + +- VST3 +- Standalone + +JUCE laddas ner automatiskt av CMake vid första bygget. --- -## Build on macOS +# Bygga på macOS -### Requirements +## 1. Installera Xcode Command Line Tools -Install CMake and Ninja: - -```bash -brew install cmake ninja -``` - -Xcode Command Line Tools are also required: +Öppna Terminal och kör: ```bash xcode-select --install ``` -### Build +Följ instruktionerna för att slutföra installationen. + +## 2. Installera Homebrew + +Om Homebrew inte redan finns installerat, kör: + +```bash +/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" +``` + +Följ instruktionerna som visas efter installationen. Homebrew kan behöva läggas till i `PATH`. + +Kontrollera sedan installationen: + +```bash +brew --version +``` + +## 3. Installera Git, CMake och Ninja + +```bash +brew install git cmake ninja +``` + +Kontrollera installationerna: + +```bash +git --version +cmake --version +ninja --version +``` + +## 4. Bygg pluginet + +Gå till projektets katalog och kör: ```bash cmake --preset mac-release cmake --build --preset mac-release ``` -The VST3 plugin is automatically installed to: +VST3-pluginet installeras automatiskt till: ```text ~/Library/Audio/Plug-Ins/VST3/Crille Bass Strip.vst3 @@ -47,35 +83,90 @@ The VST3 plugin is automatically installed to: --- -## Build on Windows +# Bygga på Windows -### Requirements +Windows-versionen kräver Git, CMake, Ninja samt Microsofts C++-kompilator och Windows SDK. -Install: +De nödvändiga verktygen kan installeras via `winget`. -- Git -- CMake -- Ninja -- Visual Studio 2022 Build Tools with **Desktop development with C++** +## 1. Installera Git -Rider can be used as the IDE. +Öppna PowerShell eller Windows Terminal och kör: -### Build +```powershell +winget install --id Git.Git -e +``` -Open a terminal in the project directory and run: +## 2. Installera CMake + +```powershell +winget install --id Kitware.CMake -e +``` + +## 3. Installera Ninja + +```powershell +winget install --id Ninja-build.Ninja -e +``` + +## 4. Installera Visual Studio 2022 Build Tools + +Installera Visual Studio Build Tools med C++-verktygen: + +```powershell +winget install --id Microsoft.VisualStudio.2022.BuildTools -e --override "--wait --passive --add Microsoft.VisualStudio.Workload.VCTools --includeRecommended" +``` + +Detta installerar bland annat de komponenter som behövs för att kompilera C++-projekt med MSVC. 【1-179a6a】 + +Alternativt kan Visual Studio Build Tools installeras manuellt. Välj då workloaden: + +```text +Desktop development with C++ +``` + +Se till att följande finns installerat: + +- MSVC C++ Build Tools +- Windows SDK +- C++ CMake tools + +## 5. Kontrollera installationen + +Stäng terminalen och öppna en ny PowerShell eller Windows Terminal. + +Kör: + +```powershell +git --version +cmake --version +ninja --version +``` + +Alla tre kommandona ska visa installerad version. + +## 6. Bygg pluginet + +Gå till projektets katalog och kör: ```powershell cmake --preset windows-release cmake --build --preset windows-release ``` -The resulting plugin will be: +Den färdiga VST3-versionen kopieras även till projektets: ```text -Crille Bass Strip.vst3 +Release/ ``` -VST3 plugins on Windows are normally installed in: +och finns där som: + +```text +Release/Crille Bass Strip.vst3 +``` + +Standardplatsen för installerade VST3-plugin på Windows är: ```text C:\Program Files\Common Files\VST3 @@ -83,18 +174,20 @@ C:\Program Files\Common Files\VST3 --- -## Plugin Formats +# Utvecklingsmiljö -Currently supported: +Projektet kräver: -- VST3 -- Standalone +- Git +- CMake +- Ninja +- C++20-kompatibel kompilator +- JUCE 8 -## Platforms +JUCE behöver inte installeras separat. Rätt version hämtas automatiskt av CMake när projektet konfigureras första gången. -- macOS -- Windows +En IDE är inte nödvändig för att bygga projektet. Rider, Visual Studio eller annan C++-IDE kan användas för utveckling. -## Author +## Författare Christian Ohlsson \ No newline at end of file