From ae3fe1c5e03704886c2989ea678e75cfbd6f2ccb Mon Sep 17 00:00:00 2001 From: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> Date: Tue, 29 Nov 2022 18:27:36 +0100 Subject: 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 --- README.md | 26 ++++++++++++++++++-------- docs/assets/downloadbutton.png | Bin 0 -> 19357 bytes 2 files changed, 18 insertions(+), 8 deletions(-) create mode 100644 docs/assets/downloadbutton.png diff --git a/README.md b/README.md index c5746ccc..521e59f8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@

-
+ +
+
+ +

# FlightCore @@ -8,17 +12,23 @@ A [Northstar](https://northstar.tf/) installer, updater, and mod-manager ![FlightCore screenshot](docs/assets/main-window-screenshot.png) -## 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` . +GitHub release (latest by date) +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 new file mode 100644 index 00000000..e799473e Binary files /dev/null and b/docs/assets/downloadbutton.png differ -- cgit v1.2.3