From d7f76fc43375bb4b5a375c90b6bd18ab1a9b7c7d Mon Sep 17 00:00:00 2001 From: Arseniy Shestakov Date: Sat, 2 Sep 2017 16:09:55 +0300 Subject: [PATCH] README: add more text and provide links to instructions on wiki --- README.md | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a5e50ef4c..eaff1181f 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,33 @@ [![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/github/vcmi/vcmi?branch=develop&svg=true)](https://ci.appveyor.com/project/vcmi/vcmi) [![Coverity Scan Build Status](https://scan.coverity.com/projects/vcmi/badge.svg)](https://scan.coverity.com/projects/vcmi) # VCMI Project -VCMI is work-in-progress attempt to recreate engine for Heroes III, giving it new and extended possibilities. To use VCMI you need to own original data files. +VCMI is work-in-progress attempt to recreate engine for Heroes III, giving it new and extended possibilities. ## Links - * Homepage: http://vcmi.eu/ - * Wiki: http://wiki.vcmi.eu/ - * Forums: http://forum.vcmi.eu/ - * Bugtracker: http://bugs.vcmi.eu/ + * Homepage: https://vcmi.eu/ + * Wiki: https://wiki.vcmi.eu/ + * Forums: https://forum.vcmi.eu/ + * Bugtracker: https://bugs.vcmi.eu/ * Slack: https://slack.vcmi.eu/ -## Installation -For installation of latest release see release announcement on http://vcmi.eu/ +## Installation guides -For building from source see project wiki at http://wiki.vcmi.eu/ +To use VCMI you need to own original data files. + + * [Android](https://wiki.vcmi.eu/Installation_on_Android) + * [Linux](https://wiki.vcmi.eu/Installation_on_Linux) + * [macOS](https://wiki.vcmi.eu/Installation_on_macOS) + * [Windows](https://wiki.vcmi.eu/Installation_on_Windows) + +## Building from source + +Platform support is constantly tested by continuous integration and CMake configuration adjusted to generate nice looking projects for all major IDE. Following guides will help you to setup build environment with no effort: + + * [On Linux](https://wiki.vcmi.eu/How_to_build_VCMI_(Linux)) + * [On Linux for Windows with MXE](https://wiki.vcmi.eu/How_to_build_VCMI_(Linux/Cmake/MXE)) + * [On macOS](https://wiki.vcmi.eu/How_to_build_VCMI_(macOS)) + * [On Windows using MSVC and Vcpkg](https://wiki.vcmi.eu/How_to_build_VCMI_(Windows/Vcpkg)) ## Copyright and license