Skip to content

Commit c0fe82f

Browse files
committed
Doc - update Windows Build instructions
1 parent db2147d commit c0fe82f

File tree

1 file changed

+10
-25
lines changed

1 file changed

+10
-25
lines changed

BUILD-WINDOWS.md

+10-25
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ In order to build Sonic Pi's various components, we need to install a few
4141
dependencies:
4242

4343
1. Visual Studio 2022
44-
2. Qt (6.7+)
44+
2. Qt (6.8+)
4545
3. CMake (3.29+)
46-
4. Ruby (3.3.1+)
46+
4. Ruby (3.4.2+)
4747
5. Elixir (1.16+)
4848

4949
Let's look at each in turn.
@@ -64,7 +64,7 @@ Note that you need to enable the "Desktop development with C++" workload. See: h
6464
Install the latest version of Qt6 (note that Qt5 may work on Windows but isn't supported) - ensure
6565
you pick 64 bit options for msvc:
6666

67-
https://download.qt.io/official_releases/qt/6.7/6.7.0/single/qt-everywhere-src-6.7.0.zip
67+
https://download.qt.io/official_releases/qt/6.8/6.8.2/single/qt-everywhere-src-6.8.2.zip
6868

6969
When selecting Qt components you need:
7070

@@ -90,10 +90,10 @@ Alternatively, the `setx` command can make global variables. (Note that
9090
after using `setx` the command line needs to be restarted for it to take
9191
effect).
9292

93-
For example, if you installed Qt to `C:\Qt\Qt6.7.0` then you could run:
93+
For example, if you installed Qt to `C:\Qt\Qt6.8.2` then you could run:
9494

9595
```
96-
setx QT_INSTALL_LOCATION C:\Qt\6.7.0\msvc2019_64
96+
setx QT_INSTALL_LOCATION C:\Qt\6.8.2\msvc2019_64
9797
```
9898

9999
(followed by restarting your command prompt)
@@ -113,9 +113,9 @@ Ruby is needed both for a number of the build steps and as the main
113113
runtime for the language server. We need to install both it and some
114114
additional libraries.
115115

116-
Firstly, install the latest version of Ruby (3.3.1 - 64 bit with devkit) from:
116+
Firstly, install the latest version of Ruby (3.4.2 - 64 bit with devkit) from:
117117

118-
https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.3.1-1/rubyinstaller-devkit-3.3.1-1-x64.exe
118+
https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.4.2-1/rubyinstaller-devkit-3.4.2-1-x64.exe
119119

120120
Once you have installed Ruby, you need to grab some additional
121121
libraries. We can do this from the command prompt with the following:
@@ -127,16 +127,6 @@ gem install rugged
127127
This uses the Ruby library management tool `gem` to install rugged which is used to
128128
store the code diffs in a local Git repository.
129129

130-
Note - with Ruby 3.3.1 you will need to modify line 321 of `lib\ruby\3.3.0\win32\registry.rb` from:
131-
132-
```
133-
data = "\0".force_encoding('ASCII-8BIT') * unpackdw(size)
134-
```
135-
to
136-
```
137-
data = "\0".b * unpackdw(size)
138-
```
139-
140130
### 1.5 Install Elixir
141131

142132
Lastly we just need to head over to the Elixir website and download and
@@ -179,17 +169,17 @@ change any future references to `C:\dev\sonic-pi` to your chosen location.
179169
Next, we need to point your build of Sonic Pi to your local Ruby
180170
installation. We can do this by creating a folder link - similar to a
181171
symbolic link on Linux and macOS. First, find out where you installed
182-
Ruby. For example, this might be `C:\Ruby33-x64`.
172+
Ruby. For example, this might be `C:\Ruby34-x64`.
183173

184174
Finally, open a console as administrator (this is necessary for making the
185175
link). Then `cd` into the `sonic-pi\app\server\native` directory within
186176
your copy of Sonic Pi's source. For example, if you put Sonic Pi within
187-
`C:\dev` and installed Ruby to `C:\Ruby33-x64` then you'd do the
177+
`C:\dev` and installed Ruby to `C:\Ruby34-x64` then you'd do the
188178
following:
189179

190180
```
191181
cd C:\dev\sonic-pi\app\server\native
192-
mklink /d ruby C:\Ruby33-x64
182+
mklink /d ruby C:\Ruby34-x64
193183
```
194184

195185

@@ -247,10 +237,6 @@ https://in-thread.sonic-pi.net
247237
## Tips
248238
- Error logs are written to `%USERPROFILE%\.sonic-pi\logs`, and are useful
249239
to diagnose any startup problems.
250-
- If a rebuild errors at the final stage of copying files, or you are
251-
otherwise having trouble starting Sonic Pi, there is
252-
win-killprocess.bat to remove Sonic Pi from memory. This will also
253-
kill SuperCollider if it has been left running.
254240
- 32bit and 64bit don't mix. Build the one you want in a clean tree.
255241
Make sure you also install all the right 32/64 bit components to match
256242
your build. 64bit is recommended on modern machines.
@@ -260,4 +246,3 @@ https://in-thread.sonic-pi.net
260246
- If you're already familiar with Visual Studio you should be able to
261247
take the existing solution file from within the `build` directory
262248
and build things with that.
263-

0 commit comments

Comments
 (0)