Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README Rework #17

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

README Rework #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b48badc
Formatted README
ElectronicsArchiver Jul 8, 2022
e62e328
Merge branch 'mlthelama:main' into main
ElectronicsArchiver Jul 9, 2022
2247e6f
Merge branch 'mlthelama:main' into main
ElectronicsArchiver Jul 12, 2022
88fa432
Merge branch 'main' into main
ElectronicsArchiver Jul 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions Documentation/Building.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@

# Building

*How to compile this mod.*

<br>

## Dependencies

[<kbd>  AutoTOML  </kbd>][AutoTOML]  
[<kbd>  CommonLibSSE  </kbd>][CommonLibSSE]  
[<kbd>  SpdLog  </kbd>][SpdLog]

<br>
<br>

## 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 .
```

<br>


<!----------------------------------------------------------------------------->

[CommonLibSSE]: https://github.com/Ryan-rsm-McKenzie/CommonLibSSE
[AutoTOML]: https://github.com/Ryan-rsm-McKenzie/AutoTOML
[SpdLog]: https://github.com/gabime/spdlog
61 changes: 44 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
<br>

<div align = center>

## Building
```
git clone https://github.com/mlthelama/ShowStats.git
cd ShowStats
---

[![Button Nexus]][Nexus]   
[![Button Build]][Build]

---

</div>

<br>
<br>

## Requirements

[<kbd>  SKSE64  </kbd>][SKSE64]  
[<kbd>  Address Library  </kbd>][Address Library]

<br>


<!----------------------------------------------------------------------------->

[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


<!--------------------------------[ Badges ]----------------------------------->

[Badge License]: https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge


<!-------------------------------[ Buttons ]----------------------------------->

[Button Nexus]: https://img.shields.io/badge/ＮＥＸＵＳMODS-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 .
```