Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Adam Higerd committed Mar 3, 2024
1 parent aac8438 commit e6dadde
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[submodule "agbplay"]
path = agbplay
url = https://github.com/ipatix/agbplay
url = https://github.com/ahigerd/agbplay
60 changes: 60 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# agbplay-gui

**agbplay-gui** is a music player for Game Boy Advance ROMs that use the MusicPlayer2000
(mp2k/m4a/"Sappy") sound engine. It is based on [agbplay](https://github.com/ipatix/agbplay)
by ipatix.

![agbplay-gui screenshot](screenshot.png)

## Building

agbplay-gui depends on the following libraries:

* Qt 5
* PortAudio

A build script is provided for compiling on Windows using MSYS2. This script will download
and build the required dependencies automatically. This script also supports cross
compiling agbplay-gui from a non-Windows system with MinGW.

First ensure that the agbplay submodule is checked out and up to date:

* `git submodule update --init --recursive`

To build on Windows using the automatic build script:

* `make -C windows`

To cross-compile a 32-bit binary using MinGW:

* `make -C windows CROSS=mingw32`

To cross-compile a 64-bit binary using MinGW:

* `make -C windows CROSS=mingw64`

To build using locally-installed libraries:

* `qmake`
* `make`

## License

**agbplay-gui** is created by Adam Higerd. It is derived from agbplay by
ipatix. Both agbplay and agbplay-gui are distributed under the terms of
the LGPLv3.

*This program is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.*

*This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
License for more details.*

*For more information about the GNU Lesser General Public License, see
[https://www.gnu.org/licenses](https://www.gnu.org/licenses).*

agbplay source code: [https://github.com/ipatix/agbplay](https://github.com/ipatix/agbplay)
12 changes: 6 additions & 6 deletions resources/about.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,22 @@
<p>
<b>agbplay-gui</b> is created by Adam Higerd. It is derived from agbplay by
ipatix. Both agbplay and agbplay-gui are distributed under the terms of
the GPLv3.
the LGPLv3.
</p>
<p>
<i>This program is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
under the terms of the GNU Lesser General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.</i>
</p>
<p>
<i>This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License for more details.</i>
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
License for more details.</i>
</p>
<p>
<i>For more information about the GNU General Public License, see
<i>For more information about the GNU Lesser General Public License, see
<a href='https://www.gnu.org/licenses'>https://www.gnu.org/licenses</a>.</i>
</p>
<p>
Expand Down
Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e6dadde

Please sign in to comment.