Skip to content

Instantly share code, notes, and snippets.

@nd-0r
Last active September 16, 2022 22:36
Show Gist options
  • Save nd-0r/9acdc0e39db322f871899eeb3d6f8830 to your computer and use it in GitHub Desktop.
Save nd-0r/9acdc0e39db322f871899eeb3d6f8830 to your computer and use it in GitHub Desktop.
JUCE Installation Instructions

New Member Setup

Here are instructions on how to install devtools. This includes some instructions for installing platform-specific toolchains and IDEs, along with general installation instructions for other software. Chances are you already have some of these tools installed already! Please follow the platform-specific instructions first, then the general instructions.


Platform-specific

MacOS (10.7+)

Instructions

JUCE

  • Go to the JUCE download page
  • Select the "Mac" button to download the latest version of the library with tools pre-built for MacOS
  • Expand the .zip file by double-clicking in Finder or running unzip ./juce-7.x.x-osx.zip in terminal
  • Move the new JUCE folder to /Users/<your username>/Applications in Finder or in terminal running mv -r ./JUCE ~/Applications/ in the directory you expanded it in.

XCode

  • Go to the MacOS App Store to install the XCode app
  • Open the terminal (/System/Applications/Utilities/Terminal.app) and run xcode-select --install to install the XCode command line tools
    • this will install the compiler, linker, debugger, etc.

GNU/Linux (Kernel version 4.x or 5.x, recent version of a mainstream distro)

Instructions

TODO

Windows (10+)

Instructions

JUCE

  • Go to the JUCE download page
  • Select the "Windows" button to download the latest version of the library with tools pre-built for Windows
  • Select the .zip archive in File Explorer and select "Compressed Folder Tools"->"Extract All"
  • Extract the JUCE folder inside your home directory, i.e. "C://Users/<your username>/", removing the name juce-x.x.x-windows from the path.

Visual Studio (a.k.a. not VSCode)

  • Follow Microsoft's instructions here
    • The community version of Visual Studio is preferable
    • For workload, you'll want to select the "Desktop Development with C/C++" one.

Git

This article is pretty clear: skip to the section "Download and Install Git for Windows."


General stuff

Installing and Configuring Git/GitHub

Git should be pre-installed on Linux and comes with the XCode CLI Tools on MacOS, described above. Follow the instructions above for Windows.

  • To authenticate with GitHub, the easiest way now is to use the GitHub CLI tool. [These instructions by GitHub] tell you how to do that for Mac, Windows, and Linux.
    • Alternatively, you can manually generate an SSH key or PAT for your GitHub account without installing the CLI tool. In that case, follow these instructions by GitHub
  • Then, run gh auth login in a terminal to login to your github account

Testing your Git configuration

  • Try to clone this repository to your computer: https://github.com/SIGMusic/WavetableDemo.git
    • to clone, open a command line (GitBash, Terminal.app, etc.), navigate to your desired directory, and type git clone https://github.com/SIGMusic/WavetableDemo.git. Alternatively, if you are using SSH keys for git authentication, type git clone [email protected]:SIGMusic/WavetableDemo.git
  • If you can complete the above steps with no errors, then you have successfully configured Git/GitHub!

Post-JUCE Configuration

Testing your JUCE installation

  • Navigate to JUCE/extras/AudioPerformanceTest
  • Open the .jucer file in the Projucer
  • On opening, you may receive up to 2 popups in the bottom left corner of your window:
    1. If there is a popup stating you must disable the splash screen, select to disable the splash screen to dismiss the popup.
    2. If there is a popup stating that your modules path is invalid, select "Set Path," or similar:
      • For the JUCE path, enter the path or browse by selecting the triple-dot button, to where you downloaded the JUCE folder above
        • The path should be something like "*/JUCE"
      • For the modules path, enter the path to the modules subdirectory inside your JUCE installation or select the triple-dot button to browse to the modules folder inside your JUCE installation.
        • The path should be something like "*/JUCE/modules"
      • Close the window
  • Click the "Save and Export to IDE" button in the Projucer, next to the exporter dropdown in the top-center of the window
  • Attempt to build the project in your IDE
    • if there aren't any build errors, congrats: You have successfully installed JUCE!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment