Skip to content

Commit fe2bcad

Browse files
committed
Merge branch 'master' into v1.0
2 parents 2ed77a2 + 8af02b4 commit fe2bcad

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

docs/modules/ROOT/pages/setup.adoc

+18-5
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,31 @@ Here are the basic requirements and dependencies that you need to satisfy in ord
88

99
. A C++20 compiler
1010
. git
11-
. https://cmake.org/[CMake] 3.5.1 or higher
11+
. https://cmake.org/[CMake] 3.16.0 or higher
1212

13-
Additionally, the following libraries are dragged as submodules:
13+
Additionally, the following libraries are automatically fetched using CMake's FetchContent:
1414

1515
1. The https://github.com/cycfi/infra/[Cycfi infra library]
1616
2. http://www.portaudio.com/[portaudio] Audio I/O library.
1717
3. http://portmedia.sourceforge.net/portmidi/[portmidi] MIDI I/O library.
1818

1919
=== C++20
2020

21-
Q currently supports the MacOS, Windows and Linux. In the Mac, we support both https://developer.apple.com/xcode/[XCode]. Q is tested with XCode 10 and XCode 11. In Windows, we support Windows 10 with https://visualstudio.microsoft.com/vs/[Visual Studio 2022]. In Linux, we support both https://clang.llvm.org/[Clang] and https://gcc.gnu.org/[gcc]. Get the latest version with a C++20 compiler. The https://www.jetbrains.com/clion/[CLion] IDE is supported on all platforms.
21+
The Q library currently supports macOS, Windows, and Linux. On macOS, we support both https://developer.apple.com/xcode/[XCode]. The Q library is tested with XCode 10 and XCode 11. On Windows, we support Windows 10 with https://visualstudio.microsoft.com/vs/[Visual Studio 2022]. On Linux, we support both https://clang.llvm.org/[Clang] and https://gcc.gnu.org/[gcc]. Get the latest version with a C++20 compiler. The https://www.jetbrains.com/clion/[CLion] IDE is supported on all platforms.
22+
23+
The Q library currently supports the following platforms and tools:
24+
25+
* MacOS
26+
** https://developer.apple.com/xcode/[XCode] (Tested with XCode 10 and XCode 11)
27+
* Windows
28+
** Windows 10 with https://visualstudio.microsoft.com/vs/[Visual Studio 2022]
29+
* Linux
30+
** https://clang.llvm.org/[Clang] (Clang 11.0.0 or later)
31+
** https://gcc.gnu.org/[gcc] (GCC 11 or later)
32+
* All platforms
33+
** https://www.jetbrains.com/clion/[CLion] IDE
34+
35+
NOTE: Additionally, the core of the Q library (q_lib), excluding the audio IO layer (q_io), is compatible with any platform that has a fully conforming C++20 compiler. This core subset has been successfully tested on various embedded platforms, including the Teensy and STM32 series.
2236

2337
=== Git
2438

@@ -30,7 +44,7 @@ git clone --recurse-submodules https://github.com/cycfi/Q.git
3044

3145
=== CMake
3246

33-
Make sure you have https://cmake.org[CMake] 3.5.1 or higher.
47+
Make sure you have https://cmake.org[CMake] 3.16.0 or higher.
3448
Follow the installation procedure for your platform.
3549

3650
=== Generating the Project using CMake
@@ -64,7 +78,6 @@ If successful, cmake will generate an Visual Studio solution project in the buil
6478
Using https://wiki.debian.org/DebianPackageManagement[dpkg packaging system],
6579
stock g++ compiler and http://www.codeblocks.org/[CodeBlocks].
6680

67-
. Install portaudio dependencies: `sudo apt-get install libasound-dev`
6881
. CD to the Q library: `cd Q`
6982
. Make a build directory: 'mkdir build'
7083
. CD to the the Q/build directory: `cd build`

0 commit comments

Comments
 (0)