Merge branch 'main' of https://github.com/Master290/cli-modplayer

Author: Master290

.github/workflows/cmake-single-platform.yml

@@ -0,0 +1,48 @@
+name: Build
+
+on:
+  push:
+    branches: [ "main" ]
+    paths-ignore:
+      - 'README.md'
+      - 'README/*.md'
+  pull_request:
+    branches: [ "main" ]
+    paths-ignore:
+      - 'README.md'
+      - 'README/*.md'
+
+env:
+  BUILD_TYPE: Release
+  BUILD_DIR: ${{ github.workspace }}/build
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y cmake g++ pkg-config libopenmpt-dev portaudio19-dev libncursesw5-dev
+
+      - name: Configure CMake
+        run: cmake -S ${{ github.workspace }} -B ${{ env.BUILD_DIR }} -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }}
+
+      - name: Build
+        run: cmake --build ${{ env.BUILD_DIR }} --config ${{ env.BUILD_TYPE }}
+
+      - name: Test
+        working-directory: ${{ env.BUILD_DIR }}
+        run: ctest -C ${{ env.BUILD_TYPE }} --output-on-failure
+
+      - name: Upload build artifact
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: modtracker-${{ env.BUILD_TYPE }}
+          path: |
+            ${{ env.BUILD_DIR }}/modtracker
+            ${{ env.BUILD_DIR }}/note_formatter_tests

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Daniar Mannanov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,4 +1,4 @@
-# cli-tracker
+# cli-modplayer
 
 A console MOD tracker player for Linux inspired by tools like ProTracker. The app streams audio through PortAudio, loads songs with libopenmpt, and shows a live channel grid in the terminal using ncurses.
 [Watch the showcase video](https://www.youtube.com/watch?v=CXP1AppBVT4)
@@ -33,6 +33,9 @@ cmake --build build
 ./build/modtracker /path/to/song.mod
 ```
 
+Or you can download one of the prebuilt binaries in the "Releases"
+Or download one from GitHub workflow artifacts.
+
 Key bindings inside the UI:
 
 - `Space` — pause or resume playback
@@ -41,3 +44,8 @@ Key bindings inside the UI:
 - `PgUp` / `PgDn` (or `u` / `d`) — page through channel columns when the module has more than four channels
 - `N` — show or hide the info overlay
 - `Q` — quit the program
+
+
+### TODO
+add crossplatform support (windows and mac)
+uhhh idk