Skip to content

Commit

Permalink
Docs - update windows build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
samaaron committed Apr 26, 2024
1 parent 02094d4 commit 1856367
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions BUILD-WINDOWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ dependencies:
1. Visual Studio 2022
2. Qt (6.7+)
3. CMake (3.29+)
4. Ruby (3.3.0+)
4. Ruby (3.3.1+)
5. Elixir (1.16+)

Let's look at each in turn.
Expand Down Expand Up @@ -113,10 +113,9 @@ Ruby is needed both for a number of the build steps and as the main
runtime for the language server. We need to install both it and some
additional libraries.

Firstly, install the latest version of Ruby (3.3.0 - 64 bit with devkit) from:

https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.3.0-1/rubyinstaller-3.3.0-1-x64.exe
Firstly, install the latest version of Ruby (3.3.1 - 64 bit with devkit) from:

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

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

Note - with Ruby 3.3.1 you will need to modify line 321 of `lib\ruby\3.3.0\win32\registry.rb\` from:

```
data = "\0".force_encoding('ASCII-8BIT') * unpackdw(size)
```
to
```
data = String.new("\0").force_encoding('ASCII-8BIT') * unpackdw(size)
```

### 1.5 Install Elixir

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

```
zgit clone https://github.com/sonic-pi-net/sonic-pi.git C:\dev\sonic-pi
git clone https://github.com/sonic-pi-net/sonic-pi.git C:\dev\sonic-pi
```

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

0 comments on commit 1856367

Please sign in to comment.