Skip to content

Commit

Permalink
prepare for release
Browse files Browse the repository at this point in the history
  • Loading branch information
Jelmerro committed Jan 27, 2022
1 parent 199afcf commit 0b6ae49
Show file tree
Hide file tree
Showing 4 changed files with 113 additions and 85 deletions.
24 changes: 18 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Garlmap
======

![icon](app/img/icon/128x128.png)

Garlmap is the Gapless Almighty Rule-based Logical Mpv Audio Player.

- Gapless playback for a wide range of formats
Expand All @@ -23,15 +25,25 @@ Garlmap is the Gapless Almighty Rule-based Logical Mpv Audio Player.
- Lyrics and gapless playback are essential features for active listening to music
- Completely offline, unless told to fetch stuff, which should be cached until you tell it not to
- Re-ordering songs to play should be configurable for that specific set of songs
- Adding a group of songs to your queue in bulk should allow you to remove them in one go too
- There should be options to clear or hide irrelevant info in the playlist automatically
- Adding a group of songs to your queue in bulk should allow you to remove them in one go

## Building
## Getting started

You NEED to install MPV from [mpv.io](https://mpv.io) or your package manager,
otherwise Garlmap WON'T be able to play anything at all.
Now download a [release from here](https://github.com/Jelmerro/Garlmap/releases).

- Install MPV from [mpv.io](https://mpv.io) or your package manager
- Clone this repo and run `npm ci` then `npm run build`
- Run or install the executables/packages from the `dist` folder
There is a ton of help included on the most right-hand pane of the application,
which you can always show the help in with `F1` regardless of current focus.
You can also find a lot of info by using the `--help` startup argument.

## Building

Only for Windows and Linux, mac is unsupported until all packages used also support it.
Please clone this repo and run `npm ci` then `npm start`.
You should now have Garlmap up and running from source,
next you can make your own executable builds using `npm run build`.
See `npm run` for other (build) options, the executables will be stored in `dist`.

## License

Expand Down
8 changes: 8 additions & 0 deletions electron-builder.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@ linux:
rpm:
fpm:
- --rpm-rpmbuild-define=_build_id_links none
mac:
category: public.app-category.music
icon: app/img/icon
target:
- target: zip
arch:
- x64
- arm64
win:
icon: app/img/icon/512x512.png
legalTrademarks: Copyright @ Jelmer van Arnhem | Licensed as free software (GPL-3.0 or later)
Expand Down
Loading

0 comments on commit 0b6ae49

Please sign in to comment.