From e69986f8c86da5539acfe031d94d59e0d43397d1 Mon Sep 17 00:00:00 2001 From: DomtronVox Date: Fri, 14 Jun 2019 07:59:47 -0400 Subject: [PATCH] Fixed some header levels in the README. --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7ac3d1c..3aacead 100644 --- a/README.md +++ b/README.md @@ -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.