From 6f5f8d92dc6f96ce54b1738310425b313844f5b1 Mon Sep 17 00:00:00 2001 From: Jan Date: Sun, 3 Mar 2024 11:47:40 +0100 Subject: [PATCH 1/3] docs: extend documentation section of readme with links to mods using OAT --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 56fb2c57..92f35400 100644 --- a/README.md +++ b/README.md @@ -77,11 +77,19 @@ You now run `make` manually or use `./scripts/make_release.sh` or `./scripts/mak The resulting binaries can be found in `build/bin/`. -## Documentation +## 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 OAT source code is licensed under [GPLv3](./LICENSE). From 105370f7eb2e19a0e5ad2964385441e55ed21850 Mon Sep 17 00:00:00 2001 From: Jan Date: Sun, 3 Mar 2024 11:48:25 +0100 Subject: [PATCH 2/3] docs: move up the documentation and example section --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 92f35400..4facccef 100644 --- a/README.md +++ b/README.md @@ -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. +## 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 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/`. -## 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 OAT source code is licensed under [GPLv3](./LICENSE). From 5aec94048c883f64cefe09f5a0e958e5ed9bb6ab Mon Sep 17 00:00:00 2001 From: Jan Date: Sun, 3 Mar 2024 11:49:51 +0100 Subject: [PATCH 3/3] docs: add clarification about building yourself and downloading a release --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 4facccef..ef6d5f83 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,9 @@ A full list of the subcomponents can be found [here](https://openassettools.dev/ ## Using the tools Either download [the latest release from Github](https://github.com/Laupetin/OpenAssetTools/releases/latest) or [build OAT yourself](#building-oat). +Building the tools yourself is only recommended if you want to do some changes to the code. +Otherwise you are probably better off just using the latest release. + You can put OAT anywhere, it does **not** need to be placed in your game folder. In fact i recommend against it to be able to better distinguish OAT files from game files.