Merge branch 'master' of github.com:robertobermudez/banshy

.github/workflows/ruby.yml

@@ -0,0 +1,43 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install dependencies
+      run: |
+        sudo apt-get update 
+        sudo apt-get install -y build-essential sqlite3 ruby-dev libgirepository1.0-dev libgtk-3-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev libunwind-dev xvfb
+
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+    #  uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: xvfb-run bundle exec rake

README.md

@@ -1,5 +1,35 @@
 # banshy!
-A flavoured-old-banshee music player
+Banshy is a multimedia player inspired by the ol' good Banshee. This project is a humble attempt to emulate the functionality of the long time ago abandoned app.  Developed in Ruby, utilizing the GTK3 library for the user interface and GStreamer for multimedia playback. With this application, users can enjoy their favorite audio and video files with ease. It allows to store, organize your media files into playlists and easily switch from video to audio files. It's compatible with Gnome Desktop.
+
+[Screencast from 31-03-2024 01:46:06.webm](https://github.com/robertobermudez/banshy/assets/1206729/179074a3-3f9a-4245-8f41-03c190e5520e)
+
+
+### Prerequisites
+
+Ruby: Make sure you have Ruby installed on your system. You can download it from https://www.ruby-lang.org.
+GTK3: Ensure that GTK3 is installed. If not, you can install it using your system's package manager. For example, on Ubuntu, you can install it with the following command:
+
+```bash
+sudo apt-get install libgtk-3-dev
+```
+GStreamer: Install GStreamer, which is used for multimedia playback. Again, you can use your system's package manager to install it. For example, on Ubuntu:
+```bash
+sudo apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev
+```
+
+Clone into your home folder
+
+```bash
+git clone https://github.com/robertobermudez/banshy.git
+```
+
+```bash
+cd banshy
+bundle exec install
+bundle exec rake migrate:up
+./banshy
+```
+
 
 ### Skeleton of the project
 .
@@ -14,5 +44,3 @@ A flavoured-old-banshee music player
 │   └── ui
 │       
 └── test
-
-banshy