Skip to content

Commit 1856367

Browse files
committed
Docs - update windows build instructions
1 parent 02094d4 commit 1856367

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

BUILD-WINDOWS.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ dependencies:
4343
1. Visual Studio 2022
4444
2. Qt (6.7+)
4545
3. CMake (3.29+)
46-
4. Ruby (3.3.0+)
46+
4. Ruby (3.3.1+)
4747
5. Elixir (1.16+)
4848

4949
Let's look at each in turn.
@@ -113,10 +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.0 - 64 bit with devkit) from:
117-
118-
https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.3.0-1/rubyinstaller-3.3.0-1-x64.exe
116+
Firstly, install the latest version of Ruby (3.3.1 - 64 bit with devkit) from:
119117

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

121120
Once you have installed Ruby, you need to grab some additional
122121
libraries. We can do this from the command prompt with the following:
@@ -128,6 +127,15 @@ gem install rugged
128127
This uses the Ruby library management tool `gem` to install rugged which is used to
129128
store the code diffs in a local Git repository.
130129

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 = String.new("\0").force_encoding('ASCII-8BIT') * unpackdw(size)
138+
```
131139

132140
### 1.5 Install Elixir
133141

@@ -153,7 +161,7 @@ code. The easiest way of getting this is likely to be cloning from GitHub
153161
into a folder on your hard drive such as `C:\dev\sonic-pi`:
154162

155163
```
156-
zgit clone https://github.com/sonic-pi-net/sonic-pi.git C:\dev\sonic-pi
164+
git clone https://github.com/sonic-pi-net/sonic-pi.git C:\dev\sonic-pi
157165
```
158166

159167
If you don't have Git installed you should be able to download a `.zip`
@@ -252,8 +260,4 @@ https://in-thread.sonic-pi.net
252260
- If you're already familiar with Visual Studio you should be able to
253261
take the existing solution file from within the `build` directory
254262
and build things with that.
255-
- For Ruby to work correctly with systems that have their locale set to
256-
Arabic, you need to modify the registry.rb in your Ruby install to
257-
force the locale to UTF-8. For more information see:
258-
https://github.com/sonic-pi-net/sonic-pi/issues/2416
259263

0 commit comments

Comments
 (0)