-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(setup): add more information in readme
- Loading branch information
Showing
4 changed files
with
77 additions
and
1 deletion.
There are no files selected for viewing
Empty file.
Empty file.
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,80 @@ | ||
# antara-gaming-sdk | ||
Antara Gaming Software Development Kit | ||
|
||
<a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-nd/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/">Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License</a>. | ||
## Prerequisites | ||
|
||
Below is the list of prerequisites to use the `antara-gaming-sdk` on your machine: | ||
|
||
- [CMake](https://cmake.org/download/) 3.14 minimum | ||
- **clang-8** minimum (Windows/Linux/Osx) | ||
- **Optional** emscripten latest (Web) | ||
- **Optional** Visual Studio 2019 | ||
- **Optional** Clang VS Toolset (installable through visual studio installer) | ||
|
||
## Getting Started | ||
|
||
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. | ||
|
||
See deployment for notes on how to deploy the project on a live system. | ||
|
||
### Build | ||
|
||
To build the project please follow the instructions below: | ||
|
||
```bash | ||
mkdir build ## bash or powershell | ||
cd build ## bash or powershell | ||
|
||
## Release or Debug are available | ||
cmake -DCMAKE_BUILD_TYPE=Debug ../ #Linux / Osx | ||
cmake -DCMAKE_BUILD_TYPE=Debug -G "Visual Studio 16 2019" -A x64 -T "ClangCl" -DCMAKE_CXX_COMPILER="C:/Program Files/LLVM/bin/clang-cl.exe" ../ #Windows | ||
|
||
## Build (Debug / Release available) | ||
cmake --build . --config Debug | ||
``` | ||
|
||
### Installing | ||
|
||
You do not need to install the gaming sdk, just use the CMake fetch_content command to use the project | ||
|
||
## Running the tests | ||
|
||
Once you have compiled the sdk gaming with the option to enable unit tests. | ||
|
||
They are located in the `bin/unit_tests` (Linux/Osx) or `bin/unit_tests/%CMAKE_BUILD_TYPE%` (Windows) folder | ||
|
||
## Deployment | ||
|
||
:construction: | ||
|
||
## Built With | ||
|
||
- [doctest](https://github.com/onqtam/doctest) - The fastest feature-rich C++11/14/17/20 single-header testing framework for unit tests and TDD http://bit.ly/doctest-docs | ||
- [doom-st](https://github.com/doom/strong_type) - C++ implementation of strong types | ||
- [EnTT](https://github.com/skypjack/entt) - Gaming meets modern C++ - a fast and reliable entity-component system (ECS). | ||
- [refl-cpp](https://github.com/veselink1/refl-cpp) A compile-time reflection library for modern C++ 🔥 | ||
- [range-v3](https://github.com/ericniebler/range-v3) Range library for C++14/17/20, basis for C++20's std::ranges | ||
- [expected](https://github.com/TartanLlama/expected) C++11/14/17 std::expected with functional-style extensions https://tl.tartanllama.xyz | ||
|
||
## Code of Conduct | ||
|
||
Before any contribution please read our [CODE OF CONDUCT](./CODE-OF-CONDUCT.md). | ||
|
||
## Contributing | ||
|
||
Please read [CONTRIBUTING.md](./CONTRIBUTING.md), contain the process for submitting pull requests to us. | ||
|
||
## Versioning | ||
|
||
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/KomodoPlatform/antara-gaming-sdk/tags). | ||
|
||
## Authors | ||
|
||
- **Roman Sztergbaum** - _Co-Creator_ - [Milerius](https://github.com/Milerius) | ||
|
||
See also the list of [contributors](./CONTRIBUTORS.md) who participated in this project. | ||
|
||
## Acknowledgments | ||
|
||
- Viktor Kirilov [onqtam](https://github.com/onqtam) for the awesome `doctest` framework. | ||
- Michele Caini [skypjack](https://github.com/skypjack) for the awesome `EnTT` framework and his help. |