Merge branch 'packaging/flatpak' into 'main'

packaging: Add support for building a Flatpak

See merge request then-try-this/samplebrain!4

.gitlab-ci.yml

@@ -18,29 +18,29 @@
 
 # see also https://docs.gitlab.com/ee/ci/runners/saas/macos_saas_runner.html
 
-.macos_saas_runners:
-  tags:
-    - shared-macos-amd64
-  image: macos-11-xcode-12
+# .macos_saas_runners:
+#   tags:
+#     - shared-macos-amd64
+#   image: macos-11-xcode-12
 
-stages:
-  - build
-  - test
+# stages:
+#   - build
+#   - test
 
-before_script:
-  - echo "started by ${GITLAB_USER_NAME}"
+# before_script:
+#   - echo "started by ${GITLAB_USER_NAME}"
 
-build:
-  extends:
-    - .macos_saas_runners
-  stage: build
-  script:
-    - echo "running scripts in the build job"
+# build:
+#   extends:
+#     - .macos_saas_runners
+#   stage: build
+#   script:
+#     - echo "running scripts in the build job"
 
-test:
-  extends:
-    - .macos_saas_runners
-  stage: test
-  script:
-    - echo "running scripts in the test job"
+# test:
+#   extends:
+#     - .macos_saas_runners
+#   stage: test
+#   script:
+#     - echo "running scripts in the test job"
 

README.md

@@ -11,31 +11,31 @@ to play in realtime.
 This allows you to interpret a sound with a different one. As we
 worked on it (during 2015 and 2016) we gradually added more and more
 tweakable parameters until it became slightly out of control.
-    
+
 ![](docs/pics/screenshot.png)
-    
+
 Quick start:
 
 1. Load a bunch of samples into the brain
 2. Click (re)generate brain
 3. Load a loop sample into the target
-4. Click (re)generate target
+4. Click (re)generate blocks
 5. Press play
 6. Tweak brain
 
 The default block size (3000) is really high to prevent CPU glitches -
 500 to 1000 is a better range.
-    
-# [Demo brain session](https://static.thentrythis.org/samplebrain/demo.samplebrain)    
+
+# [Demo brain session](https://static.thentrythis.org/samplebrain/demo.samplebrain)
 
 Load this file using "load session" not "load brain" (sessions contain
 both the target and brain samples).
-    
+
 # [Manual](docs/manual.md)
 
 Full description of all the parameters and a bit of the thinking
 behind it.
-        
+
 # Binaries
     
 * **Windows**: [samplebrain_0.18_win.zip](https://static.thentrythis.org/samplebrain/samplebrain_0.18_win.zip)
@@ -48,9 +48,9 @@ Mac note: As this software is not on the apple store, to run the
 binary you need to tell your mac it's ok: Go to System Preferences >
 Security & Privacy > General. At the bottom of the window, select
 "Allow apps to be downloaded from Anywhere".
-    
+
 **Linux install (Ubuntu)**
-    
+
     $ sudo add-apt-repository ppa:thentrythis/samplebrain
     $ sudo apt update
     $ sudo apt install samplebrain
@@ -58,21 +58,41 @@ Security & Privacy > General. At the bottom of the window, select
 If you'd like the right font, optionally:
 
     $ sudo apt install ttf-mscorefonts-installer
-    
-# Building from source
 
+# Building from source
+## Linux (Ubuntu)
 Install libraries for the sample engine (use brew on mac, MinGW on win):
-    
+
     $ sudo apt install libsndfile1-dev portaudio19-dev liblo-dev libfftw3-dev
 
 Install dependancies for the interface:
-        
+
     $ sudo apt install build-essential qtcreator qt5-default
 
 Build & run it:
 
-    $ cd app
-    $ qmake
+    $ mkdir build
+    $ cd build
+    $ qmake ..
+    $ make
+    $ sudo make install
+    $ samplebrain
+
+## Mac
+Install libraries for sample engine:
+
+    $ brew install fftw portaudio
+
+Install dependancies for the interface:
+
+    $ brew install qt
+    $ brew link qt
+
+Build & run it:
+
+    $ mkdir build
+    $ cd build
+    $ qmake ..
     $ make
     $ sudo make install
     $ samplebrain
@@ -80,11 +100,23 @@ Build & run it:
 # Mac build additions
 
 To make a mac app bundle:
-    
-* Run `macdeployqt` to copy all dependancies inside the app.
-* Copy desktop/samplebrain.icns (the icon) to the Resources directory in the bundle.
-* Edit Info.plist to add samplebrain.icns to CFBundleIconFile.
-    
+
+Run `macdeployqt` to copy all dependencies inside the app.
+
+Create Mac app bundle:
+
+    $ cd build
+    $ macdeployqt
+
+Copy desktop/samplebrain.icns (the icon) to the Resources directory in the bundle.
+
+    $ cp ../desktop/samplebrain.icns samplebrain.app/Contents/Resources
+
+Edit Info.plist to add samplebrain.icns to CFBundleIconFile. Key `CFBundleIconFile` should match:
+
+	<key>CFBundleIconFile</key>
+	<string>samplebrain.icns</string>
+
 ## What's here
 
 1. brain:
@@ -98,11 +130,11 @@ To make a mac app bundle:
 4. cooking:
     * some sketches and ideas
     * proof of concept written in python
-    * brief initial (abandoned) attempt at clojure version 
-    
+    * brief initial (abandoned) attempt at clojure version
+
 MFCC algo courtesy of the Aquila library by Zbigniew Siciarz MIT/X11
 licence 2007-2014 (see brain/src/aquila/LICENCE)
-    
+
 This program is free software licenced under GNU General Public
 License version 2 (see LICENCE).