Skip to content

Commit

Permalink
fix: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SpikeHD committed May 9, 2024
1 parent 3c47071 commit 9cdd2cd
Showing 1 changed file with 20 additions and 5 deletions.
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,25 @@

# Installation

Download the latest [release for your platform](https://github.com/SpikeHD/RogueTop/releases). The file you download depends on your operating system:
## Quick Links

* [Windows Download](https://github.com/SpikeHD/RogueTop/releases/latest/download/roguetop-default-x86_64-pc-windows-msvc-msi.zip)
* Linux
* [Debian-based Download](https://github.com/SpikeHD/RogueTop/releases/latest/download/roguetop-default-x86_64-unknown-linux-gnu-deb.zip)
* [RPM-based Download](https://github.com/SpikeHD/RogueTop/releases/latest/download/roguetop-default-x86_64-unknown-linux-gnu-rpm.zip)
* MacOS
* [Intel-based Download](https://github.com/SpikeHD/RogueTop/releases/latest/download/roguetop-default-x86_64-apple-darwin-dmg.zip)
* [M-series-based Download](https://github.com/SpikeHD/RogueTop/releases/latest/download/roguetop-default-aarch64-apple-darwin-dmg.zip)

## Other Architectures

The file you download depends on your operating system:

* For Windows, download the `.msi` installer file, or the `pc-windows` ZIP file. Builds are also provided for arm64.
* For Linux, download the `.deb` or `.rpm` installer files, or the `unknown-linux` ZIP file. ~~Builds are also provided for armv7 and arm64.~~ (coming soon)
* For Linux, download the `.deb` or `.rpm` installer files, or the `unknown-linux` ZIP file. Builds are also provided for armv7 and arm64.
* For MacOS, download the `.dmg` installer file, or the `apple-darwin` ZIP file. Builds are provided for both Intel-based (x86_64) and M-series-based MacOS systems (arm64).

Releases also come in two flavors, regular and "offline". Regular versions are very lightweight, and will load the online version of PokeRogue. Offline versions are larger, but contain the entirety of PokeRogue within the binary, and can be run without an internet connection!
Releases also come in two flavors, regular and ~~"offline"~~. Regular versions are very lightweight, and will load the online version of PokeRogue. ~~Offline versions are larger, but contain the entirety of PokeRogue within the binary, and can be run without an internet connection!~~

## Alternative Installation Methods

Expand All @@ -38,6 +50,8 @@ You can also download the latest build from [GitHub Actions](https://www.github.
# Table of Contents

* [Installation](#installation)
* [Quick Links](#quick-links)
* [Other Architectures](#other-architectures)
* [Alternative Installation Methods](#alternative-installation-methods)
* [Building](#building)
* [Prerequisites](#prerequisites)
Expand Down Expand Up @@ -92,10 +106,11 @@ Your built files will be in the `src-tauri/target` directory.

- [x] Bundled offline mode (directly in the binary, eg. should work on an airgapped machine)
- [x] Maybe move to bundled (eg. Tauri resource) but external/read from FS, no need for a 500mb binary lol
- [ ] TODO finish this
- [ ] Downloadable offline mode (update-able without redownloading a new binary every time)
- [x] Separate "lite" builds that are online-only
- [ ] Plugin system/support
- [ ] Theme system/support
- [ ] Plugin system/support?
- [ ] Theme system/support?

# Contributing

Expand Down

0 comments on commit 9cdd2cd

Please sign in to comment.