zone/OpenAssetTools
zone/OpenAssetTools
2
0
Fork 0
mirror of https://github.com/Laupetin/OpenAssetTools.git synced 2025-04-20 00:02:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: move up the documentation and example section

Browse Source
This commit is contained in:
Jan 2024-03-03 11:48:25 +01:00
parent 6f5f8d92dc
commit 105370f7eb
No known key found for this signature in database
GPG Key ID: 44B581F78FF5C57C
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -51,6 +51,19 @@ This project uses Premake to generate project files depending on your platform.
Note: The first time setting up will clone any submodules with git so the first initialization might take a bit. Note: The first time setting up will clone any submodules with git so the first initialization might take a bit.
## Documentation & Examples
The documentation can be found on the [OpenAssetTools.dev page](https://openassettools.dev).
It is hosted on Github Pages and its source can be found in the [OAT-Docs Repository](https://github.com/Laupetin/OAT-Docs).
For examples of mods that can be built with OAT you can either look into the [docs folder]() for some (currently very barebones) examples
or check out one of the following projects that are using OAT:
* [JezuzLizard/t6-fastfile-mods](https://github.com/JezuzLizard/t6-fastfile-mods)
* [Jbleezy/BO2-Reimagined](https://github.com/Jbleezy/BO2-Reimagined)
If you have a mod that you feel like would fit great here as well, feel free to open a PR to add it.
### Windows ### Windows
When building on Windows you will need to have Visual Studio 2022 installed. When building on Windows you will need to have Visual Studio 2022 installed.
@ -77,19 +90,6 @@ You now run `make` manually or use `./scripts/make_release.sh` or `./scripts/mak
The resulting binaries can be found in `build/bin/<Debug_x86|Release_x86>`. The resulting binaries can be found in `build/bin/<Debug_x86|Release_x86>`.
## Documentation & Examples
The documentation can be found on the [OpenAssetTools.dev page](https://openassettools.dev).
It is hosted on Github Pages and its source can be found in the [OAT-Docs Repository](https://github.com/Laupetin/OAT-Docs).
For examples of mods that can be built with OAT you can either look into the [docs folder]() for some (currently very barebones) examples
or check out one of the following projects that are using OAT:
* [JezuzLizard/t6-fastfile-mods](https://github.com/JezuzLizard/t6-fastfile-mods)
* [Jbleezy/BO2-Reimagined](https://github.com/Jbleezy/BO2-Reimagined)
If you have a mod that you feel like would fit great here as well, feel free to open a PR to add it.
## Legal ## Legal
OAT source code is licensed under [GPLv3](./LICENSE). OAT source code is licensed under [GPLv3](./LICENSE).