Merge pull request #2636 from fossdd/main

A bit better Documentation

Author: samaaron

.github/workflows/build.yml

@@ -1,12 +1,14 @@
 name: Build
 
 on:
+  # Do it on every push or PR on these branches
   push:
     branches: [ dev, main, workflow_dispatch, features/sp-api ]
   pull_request:
     branches: [ dev, main, workflow_dispatch, features/sp-api ]
 
 jobs:
+  # Build Sonic Pi
   build:
     name: "${{matrix.title}} (${{matrix.cc}}, ${{matrix.arch}}, ${{matrix.build_type}})"
     runs-on: ${{matrix.os}}
@@ -83,6 +85,7 @@ jobs:
         otp-version: 23.2.1
       if: matrix.os == 'ubuntu-latest'
 
+      # Install Erlang on MacOS
     - name: Mac Erlang
       continue-on-error: true
       run: |
@@ -91,6 +94,7 @@ jobs:
         brew install erlang
       if: matrix.os == 'macos-latest'
 
+      # Prebuild on Ubuntu
     - name: Prebuild Linux
       working-directory: ${{github.workspace}}/app
       env:
@@ -100,7 +104,8 @@ jobs:
         sudo apt install -y pulseaudio dbus-x11 libssl-dev ruby-dev supercollider-server sc3-plugins-server alsa-utils jackd2 libjack-jackd2-dev libjack-jackd2-0 libasound2-dev librtmidi-dev pulseaudio-module-jack
         ./linux-prebuild.sh --build-aubio
       if: matrix.os == 'ubuntu-latest'
-   
+
+      # Prebuild on Mac
     - name: Prebuild Mac
       working-directory: ${{github.workspace}}/app
       env:
@@ -110,6 +115,7 @@ jobs:
         ./mac-prebuild.sh
       if: matrix.os == 'macos-latest'
 
+    # Prebuild on Windows
     # Note that we 'hide' the msys folders on windows to stop conflicts when building 
     # Flac
     - name: Prebuild Windows
@@ -125,7 +131,8 @@ jobs:
 
       #- name: Setup tmate session
       # uses: mxschmitt/action-tmate@v3
-        
+
+      # Run Configuration Config on Ubuntu
     - name: Config Linux
       working-directory: ${{github.workspace}}/app
       env:
@@ -134,7 +141,8 @@ jobs:
       run: |
         ./linux-config.sh
       if: matrix.os == 'ubuntu-latest'
-    
+
+      # Run Configuration Config on Mac
     - name: Config Mac
       working-directory: ${{github.workspace}}/app
       env:
@@ -143,7 +151,8 @@ jobs:
       run: |
         ./mac-config.sh
       if: matrix.os == 'macos-latest'
-    
+
+      # Run Configuration Config on Windows
     - name: Config Windows
       working-directory: ${{github.workspace}}/app
       shell: cmd
@@ -154,6 +163,7 @@ jobs:
         win-config.bat
       if: matrix.os == 'windows-latest'
 
+    # Finally: Build
     - name: Do build
       working-directory: ${{github.workspace}}/app/build
       run: cmake --build . --config ${{ matrix.build_type }}

BUILD-LINUX.md

@@ -127,8 +127,8 @@ cmake --build . --config Release
 ## 4. Start Sonic Pi
 
 Finally, you can run your newly compiled `Sonic Pi` app within the `build`
-directly either by double clicking it in the Finder or via the terminal
-(from within the `build` directory):
+directly either by double clicking it in your file manager or via the terminal
+(from within the `build/gui/qt/sonic-pi` directory):
 
 ```
 ./sonic-pi