Feature/config file writing (#35)

.github/workflows/build.yml

@@ -56,7 +56,7 @@ jobs:
           cp /mingw64/bin/SDL2.dll .
           cp /mingw64/bin/libserialport-0.dll .
         fi
-        unix2dos README.md config.ini LICENSE AUDIOGUIDE.md
+        unix2dos README.md config.ini.sample LICENSE AUDIOGUIDE.md
     - name: 'Upload artifact (win32)'
       if: matrix.win == 'win32'
       uses: actions/upload-artifact@v2
@@ -72,7 +72,7 @@ jobs:
           LICENSE
           README.md
           AUDIOGUIDE.md
-          config.ini
+          config.ini.sample
     - name: 'Upload artifact (win64)'
       if: matrix.win == 'win64'
       uses: actions/upload-artifact@v2
@@ -86,7 +86,7 @@ jobs:
           LICENSE
           README.md
           AUDIOGUIDE.md
-          config.ini
+          config.ini.sample
 
   build-linux:
     runs-on: ubuntu-latest
@@ -115,4 +115,4 @@ jobs:
             README.md
             m8c
             gamecontrollerdb.txt
-            config.ini
+            config.ini.sample

README.md

@@ -54,7 +54,7 @@ make
 
 ### Start the program
 
-Connect the Teensy to your computer and start the program. It should automatically detect your device.
+Connect the M8 or Teensy (with headless firmware) to your computer and start the program. It should automatically detect your device.
 
 ```
 ./m8c
@@ -95,9 +95,14 @@ Enjoy making some nice music!
 
 ### Config
 
-The config function is currently a prototype, the config file must be named `config.ini` and must be present in the directory from which you're running the command.
+Keyboard and game controller bindings can be configured via `config.ini`.
 
-See the `config.ini` file to see the available options.
+If not found, the file will be created in one of these locations:
+Windows: C:\Users\<username>\AppData\Roaming\m8c\config.ini
+Linux: /home/<username>/.local/share/m8c/config.ini
+MacOS: /Users/<username>/Library/Application Support/m8c/config.ini
+
+See the `config.ini.sample` file to see the available options.
 
 -----------