diff --git a/Documentation/Building.md b/Documentation/Building.md new file mode 100644 index 0000000..4be77bf --- /dev/null +++ b/Documentation/Building.md @@ -0,0 +1,50 @@ + +# Building + +*How to compile this mod.* + +
+ +## Dependencies + +[  AutoTOML  ][AutoTOML]   +[  CommonLibSSE  ][CommonLibSSE]   +[  SpdLog  ][SpdLog] + +
+
+ +## Building + +1. Clone the repository: + + ```shell + git clone https://github.com/mlthelama/ShowStats.git + ``` + +2. Navigate to the root folder: + + ```shell + cd ShowStats + ``` + +3. Clone the submodules: + + ```shell + git submodule update --init --recursive + ``` + +4. Compile the code: + + ``` + cmake -B build -S . + ``` + +
+ + + + +[CommonLibSSE]: https://github.com/Ryan-rsm-McKenzie/CommonLibSSE +[AutoTOML]: https://github.com/Ryan-rsm-McKenzie/AutoTOML +[SpdLog]: https://github.com/gabime/spdlog diff --git a/README.md b/README.md index 42e4bda..35485ec 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,50 @@ -# Skyrim Character Sheet -## Nexus Mods -* [Skyrim Character Sheet](https://www.nexusmods.com/skyrimspecialedition/mods/56069/) +# Skyrim Character Sheet   [![Badge License]][License] -## End User Dependencies -* [SKSE64](https://skse.silverlock.org/) -* [Address Library for SKSE Plugins](https://www.nexusmods.com/skyrimspecialedition/mods/32444) +*Display players statistics in custom windows.* -## Build Dependencies -* [AutoTOML](https://github.com/Ryan-rsm-McKenzie/AutoTOML) -* [CommonLibSSE](https://github.com/Ryan-rsm-McKenzie/CommonLibSSE) -* [spdlog](https://github.com/gabime/spdlog) +
+
-## Building -``` -git clone https://github.com/mlthelama/ShowStats.git -cd ShowStats +--- + +[![Button Nexus]][Nexus]    +[![Button Build]][Build] + +--- + +
+ +
+
+ +## Requirements + +[  SKSE64  ][SKSE64]   +[  Address Library  ][Address Library] + +
+ + + + +[Address Library]: https://www.nexusmods.com/skyrimspecialedition/mods/32444 +[SKSE64]: https://skse.silverlock.org/ +[Nexus]: https://www.nexusmods.com/skyrimspecialedition/mods/56069/ + + +[License]: LICENSE +[Build]: Documentation/Building.md + + + + +[Badge License]: https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge + + + + +[Button Nexus]: https://img.shields.io/badge/NEXUSMODS-8197ec?style=for-the-badge&logoColor=white&logo=DocuSign +[Button Build]: https://img.shields.io/badge/Build-EF2D5E?style=for-the-badge&logoColor=white&logo=Dragonframe -git submodule update --init --recursive -cmake -B build -S . -```