Skip to content

k147-studio/kAmp

Repository files navigation

kAmp

Codacy Badge

How to build

Prerequisites

  • CMake version 3.21 or higher
  • C++ compiler with at least support for C++17 (C++20 is recommended)

Steps

Clone the repository

Our project includes the JUCE framwework as a git submodule. You will have to use some submodule commands.

git clone https://github.com/k147-studio/kAmp.git
git submodule init
git submodule update

Install dependencies

JUCE requires a few packages that are not always installed by default on all platforms.

Linux

You can find the below commands on JUCE repository via this link.

# Install a C++ compiler
sudo apt update
sudo apt install g++
# Or
sudo apt install clang

# Package dependencies
sudo apt update
sudo apt install libasound2-dev libjack-jackd2-dev ladspa-sdk libcurl4-openssl-dev  libfreetype-dev libfontconfig1-dev libx11-dev libxcomposite-dev libxcursor-dev libxext-dev libxinerama-dev libxrandr-dev libxrender-dev libwebkit2gtk-4.1-dev libglu1-mesa-dev mesa-common-dev

MacOS and Windows

Please refer to JUCE documentation and forum if you're missing dependencies.

Compile the project

On every platform, we recommand to use CLion IDE which is very easy to use when it comes to CMake.

Configure CMake on CLion

CLion basically handles CMake pretty good natively. It will advise you about the parameters needed so there shouldn't be any problem.

CMake settings

On Linux, the defaults settings should make the job.

On MacOS and Windows, you'll have to choose the generator that will be used to compile C++. You can relate to the list below :

  • Xcode on macOS
  • Unix Makefiles on Linux
  • Visual Studio 17 2022 on Windows

Create CMake Build Profile

On the top-right toolbar in CLion, clik on the build menu then select "Edit Configurations".

Build menu

Then click on "+" and select "CMake Application".

Build choice

You should have this window :

Build settings

After that, as Target, select "All targets".

On Linux, this should be enough; if it is not the case, try to set the CMakeLists.txt file at the repository root as the Executable.

If it still doesn't work or you are using another platform than linux, please refer to JetBrains official CMake documentation.

Here is an example of how to build the project using Xcode on macOS:

mkdir build
cd build
cmake .. -G "Xcode"
cmake --build .

About

kAmp is an in development virtual amplifier that lets you plug your instrument directly into your computer and apply effects.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors