From a858e45ec483b6961a010b93c522151c9483789a Mon Sep 17 00:00:00 2001 From: Yair Morgenstern Date: Wed, 10 May 2023 10:54:15 +0300 Subject: [PATCH] Update README.md - per-OS installation instructions --- README.md | 38 +++++++++++++++++--------------------- 1 file changed, 17 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 55ccd71390..49c2885b39 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ [![macport](https://img.shields.io/badge/dynamic/json?logo=apple&label=MacPorts&prefix=v&query=version&url=https%3A%2F%2Fports.macports.org%2Fapi%2Fv1%2Fports%2Funciv%2F)](https://ports.macports.org/port/unciv/) -![Build and deploy](https://github.com/yairm210/Unciv/workflows/Build%20and%20deploy/badge.svg) +![Build status](https://github.com/yairm210/Unciv/workflows/Build%20and%20test/badge.svg) [![Discord](https://img.shields.io/discord/586194543280390151?color=%237289DA&logo=discord&logoColor=%23FFFFFF)](https://discord.gg/bjrB4Xw) @@ -53,6 +53,20 @@ If not, you can help by spreading the word - vote for Unciv where you can, menti ## FAQ +## How do I install? + +- **Android** - [Google Play](https://play.google.com/store/apps/details?id=com.unciv.app) or [F-droid](https://f-droid.org/en/packages/com.unciv.app/) +- **Windows/Linux** - [itch.io](https://yairm210.itch.io/unciv), Flatpak via [Flathub](https://flathub.org/apps/details/io.github.yairm210.unciv), or [AUR](https://aur.archlinux.org/packages/unciv-bin) +- **Raspberry Pi** - [Pi-apps](https://github.com/Botspot/pi-apps) +- **MacOS** - Install [with this guide](https://yairm210.github.io/Unciv/Other/Installing-on-macOS/) +- Jars, APKs and Windows/Linux builds also available in [Releases](https://github.com/yairm210/Unciv/releases) (run jar with `java -jar Unciv.jar`) - *not recommended* since we update frequently and you will quickly become out-of-date +- [Build from scratch](https://yairm210.github.io/Unciv/Developers/Building-locally-without-Android-Studio/) if that's your thing + +### How about IOS? + +I'm not planning on it. It means paying money to Apple, yet another release path, + and since I don't have an IOS device it means I can't test it properly. + ### Will you implement {feature}? If it's in the original Civ V, then yes! @@ -71,29 +85,10 @@ As an open source project, this stuff is done in our spare time, of which there We need a clear-cut criteria to decide what to work on and what not to work on. -### Will you implement Civ VI? +#### Will you implement Civ VI? Considering how long it took to get this far, no. -### Is there a desktop version? - -Yes! Windows and Linux versions are available at [itch.io](https://yairm210.itch.io/unciv), and if you're using the Itch app, your game will stay up-to-date - and we release pretty frequently so that's an issue ;) - -Unciv can also be installed on macOS, a guide on how to do that can be found [here](https://yairm210.github.io/Unciv/Other/Installing-on-macOS/). - -If you have Java 8, and are familiar with the command line, there are (considerably smaller) JARs in [Releases](https://github.com/yairm210/Unciv/releases) which you can run with `java -jar Unciv.jar`. - -If you use Flatpaks, there's a Flatpak by [MayeulC](https://github.com/MayeulC) and you can know more about it [here](https://github.com/flathub/io.github.yairm210.unciv). Flathub link is available in the [Downloads](#downloads) section. - -If you want to build it from scratch for some reason, [we have instructions for that as well](https://yairm210.github.io/Unciv/Developers/Building-locally-without-Android-Studio/) - -### How about IOS? - -I'm not planning on it. - -It means paying money to Apple, yet another release path, - and since I don't have an IOS device it means I can't test it properly. - ### How can I learn to play? Where's the wiki? All the tutorial information is available in-game at menu > civilopedia > tutorials @@ -121,6 +116,7 @@ If anyone has any real legal sources, or can shed some light on the limits of wh | [![](https://static.itch.io/images/badge.svg)](https://yairm210.itch.io/unciv) | [![](https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png)](https://play.google.com/store/apps/details?id=com.unciv.app) | [![](https://fdroid.gitlab.io/artwork/badge/get-it-on.png)](https://f-droid.org/en/packages/com.unciv.app/) | [![](https://flathub.org/assets/badges/flathub-badge-en.svg)](https://flathub.org/apps/details/io.github.yairm210.unciv) |--- |--- |--- |--- | + ## Run with Docker If you have docker and docker-compose installed, you can: