mirror of
https://github.com/vcmi/vcmi.git
synced 2024-11-24 08:32:34 +02:00
Test moving readme to docs directory
This commit is contained in:
Ivan Savenko
parent
d78106b52b
commit
6cbc0b6a1f
45
README.md
45
README.md
@ -1,45 +0,0 @@
|
||||
[](https://github.com/vcmi/vcmi/actions/workflows/github.yml)
|
||||
[](https://scan.coverity.com/projects/vcmi)
|
||||
[](https://github.com/vcmi/vcmi/releases/tag/1.3.0)
|
||||
[](https://github.com/vcmi/vcmi/releases/tag/1.3.1)
|
||||
[](https://github.com/vcmi/vcmi/releases)
|
||||
# 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/
|
||||
* Discord: https://discord.gg/chBT42V
|
||||
|
||||
## 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:
|
||||
|
||||
* (optional) All platforms: [using Conan package manager to obtain prebuilt dependencies](docs/conan.md)
|
||||
* [On Linux](https://wiki.vcmi.eu/How_to_build_VCMI_(Linux))
|
||||
* [On Linux for Windows with Conan and mingw](https://wiki.vcmi.eu/How_to_build_VCMI_(Linux/Cmake/Conan))
|
||||
* [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))
|
||||
* [Android on any OS](https://wiki.vcmi.eu/How_to_build_VCMI_(Android))
|
||||
|
||||
## 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-2023 VCMI Team (check AUTHORS file for the contributors list)
|
||||
@ -1,79 +0,0 @@
|
||||
# Welcome to VCMI Project Wiki
|
||||
|
||||
[VCMI](VCMI "wikilink") is an open-source project aiming to reimplement
|
||||
HMM3:WoG and SoD game engines, giving it new and extended possibilities.
|
||||
|
||||
## Latest release
|
||||
|
||||
As of 28th of April 2023, we released [VCMI
|
||||
1.2.1](https://github.com/vcmi/vcmi/releases/tag/1.2.1). Now we plan to
|
||||
have releases 3-4 times per year. Daily builds are still available at
|
||||
[builds.vcmi.download](https://builds.vcmi.download/branch/develop/) but
|
||||
they are not guaranteed to be stable. So we encourage everybody to use
|
||||
them and report found bugs so that we can fix them.
|
||||
Loading saves made with different version of VCMI is usually **not**
|
||||
supported, so you may want to finish your ongoing games before
|
||||
updating.
|
||||
Please see corresponding "installation on" articles for details for your
|
||||
platform.
|
||||
|
||||
## Documentation and guidelines for users
|
||||
|
||||
- [ General information about VCMI Project](VCMI "wikilink")
|
||||
- [Frequently asked questions](Frequently_asked_questions "wikilink")
|
||||
- [Engine features](Engine_features "wikilink")
|
||||
- [Game mechanics](Game_mechanics "wikilink")
|
||||
- [Bug reporting guidelines](Bug_reporting_guidelines "wikilink")
|
||||
- [Mod list](Mod_list "wikilink")
|
||||
- [Cheat codes](Cheat_codes "wikilink")
|
||||
- [Installation](Installation "wikilink") guides:
|
||||
- [Windows](Installation_on_Windows "wikilink")
|
||||
- [macOS](Installation_on_macOS "wikilink")
|
||||
- [Linux](Installation_on_Linux "wikilink")
|
||||
- [Android](Installation_on_Android "wikilink")
|
||||
- [iOS](Installation_on_iOS "wikilink")
|
||||
|
||||
## Documentation and guidelines for modders
|
||||
|
||||
- [Modding guidelines](Modding_guidelines "wikilink")
|
||||
- [Mods repository](Mods_repository "wikilink")
|
||||
- Formats:
|
||||
- [Mod file Format](Mod_file_Format "wikilink")
|
||||
- [Town Format](Town_Format "wikilink")
|
||||
- [Hero Classes Format](Hero_Classes_Format "wikilink")
|
||||
- [Hero Format](Hero_Format "wikilink")
|
||||
- [Creature Format](Creature_Format "wikilink")
|
||||
- [Artifact Format](Artifact_Format "wikilink")
|
||||
- [Animation Format](Animation_Format "wikilink")
|
||||
- [Bonus Format](Bonus_Format "wikilink")
|
||||
- [Object Format](Object_Format "wikilink")
|
||||
- [Spell Format](Spell_Format "wikilink")
|
||||
- [Skill Format](Skill_Format "wikilink")
|
||||
|
||||
## Documentation and guidelines for developers
|
||||
|
||||
- How to build using CMake:
|
||||
- [Linux](How_to_build_VCMI_(Linux) "wikilink")
|
||||
- [Linux/MinGW (for
|
||||
Windows)](How_to_build_VCMI_(Linux/MinGW) "wikilink")
|
||||
- [macOS](How_to_build_VCMI_(macOS) "wikilink")
|
||||
- [Windows](How_to_build_VCMI_(Windows/Vcpkg) "wikilink")
|
||||
- [iOS](How_to_build_VCMI_(iOS) "wikilink")
|
||||
- [ Android](How_to_build_VCMI_(Android) "wikilink")
|
||||
- Unsupported build instructions:
|
||||
- [Windows/MSVS (Visual Studio
|
||||
2015)](How_to_build_VCMI_(Windows/Visual_Studio_2015) "wikilink")
|
||||
- [Coding guidelines](Coding_guidelines "wikilink")
|
||||
- [Code structure](Code_structure "wikilink")
|
||||
- [Logging API](Logging_API "wikilink")
|
||||
- Development environment guides:
|
||||
- [Development with Qt
|
||||
Creator](Development_with_Qt_Creator "wikilink")
|
||||
|
||||
## VCMI Places
|
||||
|
||||
- [Website](https://vcmi.eu/)
|
||||
- [Forum](https://forum.vcmi.eu/)
|
||||
- [Bugtracker](https://bugs.vcmi.eu/)
|
||||
- [Slack invite page](https://slack.vcmi.eu/)
|
||||
- [GitHub repository](https://github.com/vcmi/vcmi)
|
||||
96
docs/Readme.md
Normal file
96
docs/Readme.md
Normal file
@ -0,0 +1,96 @@
|
||||
[](https://github.com/vcmi/vcmi/actions/workflows/github.yml)
|
||||
[](https://github.com/vcmi/vcmi/releases/tag/1.3.0)
|
||||
[](https://github.com/vcmi/vcmi/releases/tag/1.3.1)
|
||||
[](https://github.com/vcmi/vcmi/releases)
|
||||
|
||||
# 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/
|
||||
* Forums: https://forum.vcmi.eu/
|
||||
* Bugtracker: https://github.com/vcmi/vcmi/issues
|
||||
* Slack: https://slack.vcmi.eu/
|
||||
* Discord: https://discord.gg/chBT42V
|
||||
|
||||
## Latest release
|
||||
|
||||
Latest release can be found [here](https://github.com/vcmi/vcmi/releases/latest). As of right now we plan to have major releases around 3 times per year. Daily builds are still available at [builds.vcmi.download](https://builds.vcmi.download/branch/develop/) but they are not guaranteed to be stable. So we encourage everybody to use them and report found bugs so that we can fix them.
|
||||
Loading saves made with different major version of VCMI is usually **not** supported, so you may want to finish your ongoing games before updating.
|
||||
Please see corresponding installation guide articles for details for your platform.
|
||||
|
||||
## 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)
|
||||
|
||||
## Documentation and guidelines for players
|
||||
|
||||
- [General information about VCMI Project](VCMI "wikilink")
|
||||
- [Frequently asked questions](Frequently_asked_questions "wikilink")
|
||||
- [Engine features](Engine_features "wikilink")
|
||||
- [Game mechanics](Game_mechanics "wikilink")
|
||||
- [Bug reporting guidelines](players/Bug_Reporting_Guidelines.md)
|
||||
- [Mod list](Mod_list "wikilink")
|
||||
- [Cheat codes](Cheat_Codes.md)
|
||||
- [Cheat codes](Client_Commands.md)
|
||||
|
||||
### Installation guides
|
||||
- [Windows](Installation_on_Windows "wikilink")
|
||||
- [macOS](Installation_on_macOS "wikilink")
|
||||
- [Linux](Installation_on_Linux "wikilink")
|
||||
- [Android](Installation_on_Android "wikilink")
|
||||
- [iOS](Installation_on_iOS "wikilink")
|
||||
|
||||
## Documentation and guidelines for game modders
|
||||
|
||||
- [Modding guidelines](Modding_guidelines "wikilink")
|
||||
- [Mods repository](Mods_repository "wikilink")
|
||||
- Formats:
|
||||
- [Mod file Format](Mod_file_Format "wikilink")
|
||||
- [Town Format](Town_Format "wikilink")
|
||||
- [Hero Classes Format](Hero_Classes_Format "wikilink")
|
||||
- [Hero Format](Hero_Format "wikilink")
|
||||
- [Creature Format](Creature_Format "wikilink")
|
||||
- [Artifact Format](Artifact_Format "wikilink")
|
||||
- [Animation Format](Animation_Format "wikilink")
|
||||
- [Bonus Format](Bonus_Format "wikilink")
|
||||
- [Object Format](Object_Format "wikilink")
|
||||
- [Spell Format](Spell_Format "wikilink")
|
||||
- [Skill Format](Skill_Format "wikilink")
|
||||
|
||||
## Documentation and guidelines for developers
|
||||
|
||||
- How to build using CMake:
|
||||
- [Linux](How_to_build_VCMI_(Linux) "wikilink")
|
||||
- [Linux/MinGW (for
|
||||
Windows)](How_to_build_VCMI_(Linux/MinGW) "wikilink")
|
||||
- [macOS](How_to_build_VCMI_(macOS) "wikilink")
|
||||
- [Windows](How_to_build_VCMI_(Windows/Vcpkg) "wikilink")
|
||||
- [iOS](How_to_build_VCMI_(iOS) "wikilink")
|
||||
- [ Android](How_to_build_VCMI_(Android) "wikilink")
|
||||
- Unsupported build instructions:
|
||||
- [Windows/MSVS (Visual Studio
|
||||
2015)](How_to_build_VCMI_(Windows/Visual_Studio_2015) "wikilink")
|
||||
- [Coding guidelines](Coding_guidelines "wikilink")
|
||||
- [Code structure](Code_structure "wikilink")
|
||||
- [Logging API](Logging_API "wikilink")
|
||||
- Development environment guides:
|
||||
- [Development with Qt
|
||||
Creator](Development_with_Qt_Creator "wikilink")
|
||||
|
||||
## Documentation and guidelines for maintainers
|
||||
|
||||
## 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-2023 VCMI Team (check AUTHORS file for the contributors list)
|
||||
Loading…
Reference in New Issue
Block a user