Skip to content

Commit fae81a3

Browse files
committed
Docs - update paths to reflect removal of app/gui/qt dir
1 parent 608597b commit fae81a3

File tree

3 files changed

+9
-22
lines changed

3 files changed

+9
-22
lines changed

BUILD-LINUX.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -60,15 +60,15 @@ Note: please make sure that you have gcc12 installed. Compiling vcpkg dependenci
6060
### 1.1 Debian
6161
The following is a rough list of Debian packages that are needed that can serve as a starting position:
6262
```bash
63-
sudo apt-get install -y build-essential git libssl-dev ruby-dev elixir erlang-dev erlang-xmerl qt6-tools-dev qt6-tools-dev-tools libqt6svg6-dev libqt6opengl6-dev supercollider-server sc3-plugins-server alsa-utils libasound2-dev cmake ninja-build pipewire-jack libspa-0.2-jack qt6-wayland libwayland-dev libxkbcommon-dev libegl1-mesa-dev libx11-dev libxft-dev libxext-dev qpwgraph compton
63+
sudo apt-get install -y build-essential git libssl-dev ruby-dev elixir erlang-dev erlang-xmerl qt6-tools-dev qt6-tools-dev-tools libqt6svg6-dev libqt6opengl6-dev supercollider-server sc3-plugins-server alsa-utils libasound2-dev cmake ninja-build pipewire-jack libspa-0.2-jack qt6-wayland libwayland-dev libxkbcommon-dev libegl1-mesa-dev libx11-dev libxft-dev libxext-dev qpwgraph compton m4 libaubio-dev libpng-dev libboost-all-dev
6464
```
6565

6666
*Notes:*
6767

6868
1. Check the version of `Qt` after package installation.
6969

7070
* Check your current Qt version with `qmake --version`.
71-
* If it is too old (see dependency list above) you should find a way to update `Qt` before going to the build step.
71+
* If it is too old (see dependency list above) you should find a way to update `Qt` before going to the build step.
7272

7373
3. The main repositories may not have a recent enough version of
7474
Elixir. If this is the case, you can install it via **one** of the

BUILD-MAC.md

+5-18
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
Hello there lovely macOS user - welcome to our build instructions.
44

5-
65
### Installing vs Building
76

87
These instructions are for people wanting to build/compile their own
@@ -21,21 +20,19 @@ https://in-thread.sonic-pi.net
2120
OK, so just to get you prepared, we're going to do a few things:
2221

2322
1. Install the various dependencies that Sonic Pi needs both to be built
24-
and to run
23+
and to run
2524
2. Build Sonic Pi using a command line script
2625
3. Start your new Sonic Pi using your newly built app
2726

28-
2927
### Notes
3028

31-
* If you have any issues building Sonic Pi on macOS please open up an
29+
- If you have any issues building Sonic Pi on macOS please open up an
3230
issue on GitHub and we'll try our best to assist you:
3331
https://github.com/sonic-pi-net/sonic-pi/issues
34-
* These build instructions assume you're running under macOS 12+. If
32+
- These build instructions assume you're running under macOS 12+. If
3533
you're using an older version of macOS some steps may need
3634
modification.
3735

38-
3936
## 1. Installing Dependencies
4037

4138
In order to build Sonic Pi's various components, we need to install a
@@ -45,15 +42,13 @@ few dependencies:
4542
2. Homebrew
4643
3. All other dependencies - Qt6 (6.2+), CMake (3.18+), Elixir(1.13+), pkg-config
4744

48-
4945
### 1.1 Install Xcode
5046

5147
Firstly open the App Store and install the latest Xcode (12.1 at the
5248
time of writing). Also install the command line tools which will give
5349
you access to a compiler necessary to build the GUI and other
5450
components.
5551

56-
5752
### 1.2 Install Homebrew
5853

5954
Install [Homebrew](https://brew.sh) by running the following within a terminal:
@@ -68,7 +63,6 @@ trusted system used by many developers globally you're always
6863
recommended to read any scripts before executing them to reassure
6964
yourself they aren't doing anything malicious._
7065

71-
7266
### 1.3 Install all other dependencies
7367

7468
Once you have Homebrew installed, pulling in the rest of the
@@ -79,7 +73,6 @@ brew install qt cmake elixir pkg-config
7973
8074
```
8175

82-
8376
## 2. Preparing the Build
8477

8578
Once we have installed all the dependencies, we're almost ready to build
@@ -102,7 +95,6 @@ From now on these instructions will assume you downloaded the source
10295
into `~/Development/sonic-pi`. If you used a different location be sure to
10396
change any future references to `~/Development/sonic-pi` to your chosen location.
10497

105-
10698
## 3. Running the Build
10799

108100
Now we're ready to build everything. This is achieved with one single command
@@ -113,7 +105,6 @@ which will:
113105
2. Run the config script to set up the build system.
114106
3. Run cmake to build the final entry-point binary.
115107

116-
117108
### 3.1 Move to the app directory
118109

119110
Firstly, we need to change to the `app` directory at the root of the Sonic Pi repository:
@@ -122,7 +113,6 @@ Firstly, we need to change to the `app` directory at the root of the Sonic Pi re
122113
cd ~/Development/sonic-pi/app
123114
```
124115

125-
126116
### 3.2 Build All
127117

128118
Next we run the build-all script for macOS:
@@ -131,25 +121,22 @@ Next we run the build-all script for macOS:
131121
./mac-build-all.sh
132122
```
133123

134-
135124
## 4. Start Sonic Pi
136125

137-
Finally, you can run your newly compiled `Sonic Pi` app within the new `build`
126+
Finally, you can run your newly compiled `Sonic Pi` app within the new `build/gui`
138127
directly either by double clicking it in the Finder or via the terminal:
139128

140129
```
141-
./build/Sonic\ Pi.app/Contents/MacOS/Sonic\ Pi
130+
./build/gui/Sonic\ Pi.app/Contents/MacOS/Sonic\ Pi
142131
143132
```
144133

145-
146134
## Good Luck!
147135

148136
Good luck and please share your new live coding adventure with us over on:
149137

150138
https://in-thread.sonic-pi.net
151139

152-
153140
#### Anaconda users beware!
154141

155142
Anaconda (a popular data science toolkit) installs a lot of extra programs, including one called `macdeployqt` which conflicts with the build process mentioned above.

BUILD-WINDOWS.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -227,13 +227,13 @@ win-build-all.bat
227227
Finally, you can run your newly compiled Sonic Pi from the `build` directory:
228228

229229
```
230-
gui\qt\Release\sonic-pi.exe
230+
gui\Release\sonic-pi.exe
231231
```
232232

233233
Or from anywhere using the full path:
234234

235235
```
236-
C:\dev\sonic-pi\app\build\gui\qt\Release\sonic-pi.exe
236+
C:\dev\sonic-pi\app\build\gui\Release\sonic-pi.exe
237237
```
238238

239239

0 commit comments

Comments
 (0)