|
|
@ -7,7 +7,7 @@ ModEasy is a small, customizable library that provides easy modding support to a |
|
|
|
|
|
|
|
MIT, see LICENSE file for details or https://choosealicense.com/licenses/mit/. |
|
|
|
|
|
|
|
## Planned Features |
|
|
|
# Planned Features |
|
|
|
|
|
|
|
* Support Linux, Windows, and MacOS. |
|
|
|
* Functional out of the box. |
|
|
@ -23,16 +23,16 @@ MIT, see LICENSE file for details or https://choosealicense.com/licenses/mit/. |
|
|
|
* Add hooks to the API registration code. |
|
|
|
* Single header option if possible. |
|
|
|
|
|
|
|
## Build Instructions |
|
|
|
# Build Instructions |
|
|
|
|
|
|
|
### Install prerequisites |
|
|
|
## Install prerequisites |
|
|
|
To build you need cmake, and a c++ 11 capable compiler. |
|
|
|
|
|
|
|
#### Ubuntu |
|
|
|
### Ubuntu |
|
|
|
|
|
|
|
sudo apt install build-essential cmake |
|
|
|
|
|
|
|
### Compile |
|
|
|
## Compile |
|
|
|
|
|
|
|
mkdir build && cd build && cmake .. && make -j2 |
|
|
|
|
|
|
@ -41,7 +41,7 @@ You can make the -j# be "number of core" - 1 for faster build times. |
|
|
|
If you want to run the unit tests, after the above commands run: |
|
|
|
make test |
|
|
|
|
|
|
|
## Usage |
|
|
|
# Usage |
|
|
|
|
|
|
|
As stated above the library tries to function out of the box. Once you install the library using it in your code is fairly simple. |
|
|
|
|
|
|
|