From 8b9bad97f6e46425b1ece5acb94c4ece6c9c1ec6 Mon Sep 17 00:00:00 2001 From: BlackMATov Date: Thu, 10 Jan 2019 18:25:09 +0700 Subject: [PATCH] add build instructions --- BUILD_INSTRUCTIONS.md | 58 +++++++++++++++++++++++++++++++++++++++++++ README.md | 18 ++++++++------ 2 files changed, 68 insertions(+), 8 deletions(-) create mode 100644 BUILD_INSTRUCTIONS.md diff --git a/BUILD_INSTRUCTIONS.md b/BUILD_INSTRUCTIONS.md new file mode 100644 index 0000000..b083d76 --- /dev/null +++ b/BUILD_INSTRUCTIONS.md @@ -0,0 +1,58 @@ +# Build Instructions + +## * Requirements + +- [git](https://git-scm.com/) +- [git-lfs](https://git-lfs.github.com/) +- [cmake](https://cmake.org/) **>= 3.11** +- [gcc](https://www.gnu.org/software/gcc/) **>= 4.9** or [clang](https://clang.llvm.org/) **>= 3.8** or [msvc](https://visualstudio.microsoft.com/) **>= 2015** + +## * Cloning + +```bash +$ git clone --recursive git://github.com/enduro2d/enduro2d-bootstrap.git +$ cd enduro2d-bootstrap +``` + +> or + +```bash +$ git clone git://github.com/enduro2d/enduro2d-bootstrap.git +$ cd enduro2d-bootstrap +$ git submodule update --init --recursive +``` + +## * Building + +```bash +$ cd your_bootstrap_repository_directory +$ mkdir build && cd build +$ cmake -DCMAKE_BUILD_TYPE=Release .. +$ cmake --build . -- -j8 + +# also you can generate Xcode project +$ cd your_bootstrap_repository_directory +$ mkdir xcode-build && cd xcode-build +$ cmake -G Xcode .. +$ open enduro2d-bootstrap.xcodeproj + +# or Visual Studio project +$ cd your_bootstrap_repository_directory +$ mkdir msvc-build && cd msvc-build +$ cmake -G "Visual Studio 15 2017" .. +$ start enduro2d-bootstrap.sln +``` + +## * Running + +```bash +$ cd your_bootstrap_build_directory +$ ./enduro2d-bootstrap +``` + +## * Links + +- CMake: https://cmake.org/ +- CMake documentation: https://cmake.org/documentation/ +- CMake FAQ: https://gitlab.kitware.com/cmake/community/wikis/FAQ + diff --git a/README.md b/README.md index 40123fe..586d24e 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,18 @@ [![license][badge.license]][license] [![paypal][badge.paypal]][paypal] -[badge.travis]: https://img.shields.io/travis/enduro2d/enduro2d-bootstrap/master.svg?logo=travis&style=for-the-badge -[badge.appveyor]: https://img.shields.io/appveyor/ci/BlackMATov/enduro2d-bootstrap/master.svg?logo=appveyor&style=for-the-badge -[badge.language]: https://img.shields.io/badge/language-C%2B%2B14-red.svg?style=for-the-badge -[badge.license]: https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge -[badge.paypal]: https://img.shields.io/badge/donate-PayPal-orange.svg?logo=paypal&colorA=00457C&style=for-the-badge +## [Build Instructions](./BUILD_INSTRUCTIONS.md) + +## [License (MIT)](./LICENSE.md) + +[badge.travis]: https://img.shields.io/travis/enduro2d/enduro2d-bootstrap/master.svg?logo=travis +[badge.appveyor]: https://img.shields.io/appveyor/ci/BlackMATov/enduro2d-bootstrap/master.svg?logo=appveyor +[badge.language]: https://img.shields.io/badge/language-C%2B%2B14-red.svg +[badge.license]: https://img.shields.io/badge/license-MIT-blue.svg +[badge.paypal]: https://img.shields.io/badge/donate-PayPal-orange.svg?logo=paypal&colorA=00457C [travis]: https://travis-ci.org/enduro2d/enduro2d-bootstrap [appveyor]: https://ci.appveyor.com/project/BlackMATov/enduro2d-bootstrap [language]: https://en.wikipedia.org/wiki/C%2B%2B14 [license]: https://en.wikipedia.org/wiki/MIT_License -[paypal]: https://www.paypal.me/matov - -## [License (MIT)](./LICENSE.md) +[paypal]: https://www.paypal.me/matov \ No newline at end of file