diff options
| author | GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> | 2022-11-29 18:27:36 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-29 18:27:36 +0100 |
| commit | ae3fe1c5e03704886c2989ea678e75cfbd6f2ccb (patch) | |
| tree | 8f67d6847cc32c59a25707e2e65a237d22688c2d | |
| parent | e3237e8cb95424da5f1ae8d1f48805a1b6760a79 (diff) | |
| download | FlightCore-ae3fe1c5e03704886c2989ea678e75cfbd6f2ccb.tar.gz FlightCore-ae3fe1c5e03704886c2989ea678e75cfbd6f2ccb.zip | |
docs: Add download button to README (#87)
* docs: Add download button to README
* docs: Move Roadmap to the end of README
* docs: Improve installation section
More structured and hopefully easier to follow.
* docs: Add shields for version and GitHub downloads
| -rw-r--r-- | README.md | 26 | ||||
| -rw-r--r-- | docs/assets/downloadbutton.png | bin | 0 -> 19357 bytes |
2 files changed, 18 insertions, 8 deletions
@@ -1,5 +1,9 @@ <p align="center"> - <img src="docs/assets/Square310x310Logo.png" width="200px"><br> + <img src="docs/assets/Square310x310Logo.png" width="200px"> + <br> + <br> + <a href="https://github.com/R2NorthstarTools/FlightCore/releases/download/v1.1.0/FlightCore_1.1.0_x64_en-US.msi"><img src="docs/assets/downloadbutton.png" width="300px"></a> + <br> </p> # FlightCore @@ -8,17 +12,23 @@ A [Northstar](https://northstar.tf/) installer, updater, and mod-manager  -## Roadmap +## Install ---> See https://github.com/R2NorthstarTools/FlightCore/issues/1 +Downloads are available on the [releases page](https://github.com/R2NorthstarTools/FlightCore/releases). + +**Windows:** Download `FlightCore_X.Y.Z_x64_en-US.msi` and then run the installer by double-clicking the file. + +**Linux:** Download `flight-core_X.Y.Z_amd64.AppImage`, put it in a preferred location and make it executable. A Flatpak version is planned for the future. -## Download +All versions of FlightCore feature an auto-updater that will ask to self-update on new releases. -Head to over to [releases](https://github.com/R2NorthstarTools/FlightCore/releases) and download -- **Windows:** `FlightCore_X.Y.Z_x64_en-US.msi` -or -- **Linux:** `flight-core_X.Y.Z_amd64.AppImage` . +<a href="https://github.com/R2NorthstarTools/FlightCore/releases"><img src="https://img.shields.io/github/v/release/R2NorthstarTools/FlightCore" alt="GitHub release (latest by date)"></a> +<img src="https://img.shields.io/github/downloads/R2NorthstarTools/FlightCore/latest/total" alt="GitHub release downloads (latest by date)"> ## Development If you'd like to contribute to FlightCore, see [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md) + +## Roadmap + +--> See https://github.com/R2NorthstarTools/FlightCore/issues/1 diff --git a/docs/assets/downloadbutton.png b/docs/assets/downloadbutton.png Binary files differnew file mode 100644 index 00000000..e799473e --- /dev/null +++ b/docs/assets/downloadbutton.png |
