Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rephrase readme, copy license to release #82

Merged
merged 1 commit into from
May 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/build-optimized.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,9 @@ jobs:
run: echo version=$(git rev-list --count master) >> $GITHUB_OUTPUT
- name: Create zips
run: |
zip -9 ./flips-linux.zip ./builds/linux-x64-gui.zip/flips
zip -9 ./flips-windows.zip ./builds/windows-x64-gui.zip/flips.exe
#zip -9 ./flips-macos.zip ./builds/macos-m1-gui.zip/flips
zip -9 ./flips-linux.zip ./builds/linux-x64-gui.zip/flips COPYING COPYING.gpl3
zip -9 ./flips-windows.zip ./builds/windows-x64-gui.zip/flips.exe COPYING COPYING.gpl3
#zip -9 ./flips-macos.zip ./builds/macos-m1-gui.zip/flips COPYING COPYING.gpl3
- name: Upload GitHub Release
uses: svenstaro/[email protected]
with:
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ Features:
- Can remembers which ROMs you've used, and use them again if it thinks it's correct (BPS only, GUI only)
- Can launch other programs after patching the ROMs; together with the above, this allows you to double click a BPS to launch an emulator (GUI only)

Floating IPS is in maintenance mode. Bug reports and pull requests will be read, but feature requests are unlikely to be implemented. Releases are automated for every commit, meaning the release schedule is highly erratic.
Floating IPS is in maintenance mode. Bug reports and pull requests will be read, but feature requests are unlikely to be implemented. Releases are automated for every commit, meaning the release schedule is highly erratic. You can find them [at the release page](https://github.com/Alcaro/Flips/releases).
Alternatively, Linux users can also download binaries from [Flathub](https://flathub.org/apps/com.github.Alcaro.Flips).

Third-party forks, or separate tools, covering usecases this version doesn't (this only acknowledges their existence, and is not an endorsement; I haven't used most of them):
- [Floating IPS](https://github.com/Alcaro/Flips); the original Floating IPS, in case you're currently looking at a fork
Expand All @@ -21,18 +22,17 @@ Third-party forks, or separate tools, covering usecases this version doesn't (th
Compilation - Linux:
- `sudo apt-get install g++ build-essential`; for GUI support, also `sudo apt-get install libgtk-3-dev pkg-config`; adjust for your distro if necessary
- `./make-linux.sh` to build an optimized binary; for development, use `make CFLAGS=-g` (ignore make-maintainer.sh)
- Alternatively, if you prefer binaries, `flatpak install com.github.Alcaro.Flips`

Compilation - OSX, other Unix, or anything else with a C++ compiler:
- Install a C++ compiler
- `clang++ *.c *.cpp -O3 -o flips` (with changes as appropriate)
- For GTK GUI support, use some suitable variant of `clang++ *.c *.cpp -O3 -o flips -DFLIPS_GTK -lgtk3`
- For better optimizations (profiling/etc), extract the appropriate commands from Makefile and make-linux.sh
- For better optimizations (profiling/etc), use `./make-macos.sh`

Compilation - Windows:
- Install [mingw-w64](https://winlibs.com/), or similar
- `mingw32-make CFLAGS=-O3` (GUI is automatically enabled), or extract the appropriate optimization commands from make-linux.sh
- Alternatively, [here's a binary](https://www.smwcentral.net/?p=section&a=details&id=11474) (though it's quite outdated).
- For better optimization, use `./make-windows.sh`

Usage:
- If GUI is enabled, just run the program. File pickers' window titles tell what they want; Enable automatic ROM picker and Run in Emulator can cause file pickers to appear and disappear depending on the chosen patch, making usage less predictable, so it's disabled by default.
Expand Down