vcmi/README.md

[![GitHub](https://github.com/vcmi/vcmi/actions/workflows/github.yml/badge.svg)](https://github.com/vcmi/vcmi/actions/workflows/github.yml)
[![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.

## Links

 * Homepage:   https://vcmi.eu/
 * Wiki:       https://wiki.vcmi.eu/
 * Forums:     https://forum.vcmi.eu/
 * Bugtracker: https://github.com/vcmi/vcmi/issues
 * Slack:      https://slack.vcmi.eu/

## Installation guides

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)
 * [iOS](https://wiki.vcmi.eu/Installation_on_iOS)

## 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))
 * [iOS on macOS](https://wiki.vcmi.eu/How_to_build_VCMI_(iOS))

## Copyright and license

VCMI Project source code is licensed under GPL version 2 or later.
VCMI Project assets are licensed under CC-BY-SA 4.0. Assets sources and information about contributors are available under following link: [https://github.com/vcmi/vcmi-assets]

Copyright (C) 2007-2022  VCMI Team (check AUTHORS file for the contributors list)
Replaced Travis CI build badge 2021-07-26 19:24:31 +02:00			`[![GitHub](https://github.com/vcmi/vcmi/actions/workflows/github.yml/badge.svg)](https://github.com/vcmi/vcmi/actions/workflows/github.yml)`
AppVeyor: add status badge README.md 2017-07-04 03:08:13 +02:00			`[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/github/vcmi/vcmi?branch=develop&svg=true)](https://ci.appveyor.com/project/vcmi/vcmi)`
Add Coverity Scan status badge 2016-11-24 18:51:27 +02:00			`[![Coverity Scan Build Status](https://scan.coverity.com/projects/vcmi/badge.svg)](https://scan.coverity.com/projects/vcmi)`
Hopefully - more useful readme file 2014-04-08 13:49:18 +03:00			`# VCMI Project`
README: add more text and provide links to instructions on wiki 2017-09-02 15:09:55 +02:00			`VCMI is work-in-progress attempt to recreate engine for Heroes III, giving it new and extended possibilities.`
Reverted r731 2009-02-14 16:37:13 +02:00
Hopefully - more useful readme file 2014-04-08 13:49:18 +03:00			`## Links`
Reverted r731 2009-02-14 16:37:13 +02:00
README: add more text and provide links to instructions on wiki 2017-09-02 15:09:55 +02:00			`* Homepage: https://vcmi.eu/`
			`* Wiki: https://wiki.vcmi.eu/`
			`* Forums: https://forum.vcmi.eu/`
Change issues link to github issues link 2022-09-27 05:57:51 +02:00			`* Bugtracker: https://github.com/vcmi/vcmi/issues`
README: add link to Slack invite page 2017-07-02 17:09:33 +02:00			`* Slack: https://slack.vcmi.eu/`
Reverted r731 2009-02-14 16:37:13 +02:00
README: add more text and provide links to instructions on wiki 2017-09-02 15:09:55 +02:00			`## Installation guides`
Hopefully - more useful readme file 2014-04-08 13:49:18 +03:00
README: add more text and provide links to instructions on wiki 2017-09-02 15:09:55 +02:00			`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)`
add instructions for iOS 2022-08-16 15:01:43 +02:00			`* [iOS](https://wiki.vcmi.eu/Installation_on_iOS)`
README: add more text and provide links to instructions on wiki 2017-09-02 15:09:55 +02:00
			`## 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))`
add instructions for iOS 2022-08-16 15:01:43 +02:00			`* [iOS on macOS](https://wiki.vcmi.eu/How_to_build_VCMI_(iOS))`
Hopefully - more useful readme file 2014-04-08 13:49:18 +03:00
			`## Copyright and license`

Updated readme to with info on assets license, including link to not-yet-existing vcmi-assets repository 2014-07-03 19:49:42 +03:00			`VCMI Project source code is licensed under GPL version 2 or later.`
			`VCMI Project assets are licensed under CC-BY-SA 4.0. Assets sources and information about contributors are available under following link: [https://github.com/vcmi/vcmi-assets]`
Hopefully - more useful readme file 2014-04-08 13:49:18 +03:00
Feature: Army Management Shortcuts should work as in HD+ Mod 2021-11-28 14:57:38 +02:00			`Copyright (C) 2007-2022 VCMI Team (check AUTHORS file for the contributors list)`