docs: update

gottyduke · Aug 31, 2023 · 24569fd · 24569fd
1 parent adf0cc5
commit 24569fd
Showing 1 changed file with 30 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
-# BG3_PluginTemplate
- Native dll plugin template ~~for Baldur's Gate 3~~ various games. 
+# 📑 PluginTemplate
+Generic native dll plugin template for various games.
 
-## Requirements
+## ⚙ Requirements
 
 - [CMake](https://cmake.org/)
   - Add this to your `PATH`
@@ -12,16 +12,38 @@
   - Add the environment variable `VCPKG_ROOT` with the value as the path to the folder containing vcpkg
 - [Visual Studio Community 2022](https://visualstudio.microsoft.com/)
   - Desktop development with C++
-- Game Target
+- [Deploy target](#📦-deployment)
   - Set custom deploy rules accordingly
 
-## Register Visual Studio as a Generator
+## 📦 Deployment
+
+This plugin template comes with a simple custom deployer script to enable custom distribution rules fitting most use cases.  
+To get started on adding custom deploy rules, check out the [default examples](PluginTemplate/dist/rules).  
+| action    | usage                                                        |
+| --------- | ------------------------------------------------------------ |
+| `base`    | set `params[0]` to `params[1]`                               |
+| `copy`    | copy `params[0]` to `params[1]`                              |
+| `copy_if` | do `copy` if file exists                                     |
+| `package` | add `params[0..-1]` list of sources to zip file `params[-1]` |
+| `remove`  | remove `params` list of sources                              |
+| `script`  | execute raw powershell script                                |
+The following base variables are provided by default:
+```
+cmake_output    // this is the binary output path
+dist            // this is the dist folder path, also the working directory of deployer script
+project_name    // project name same as CMakeLists
+project_version // project version same as CMakeLists
+```
+
+## 💻 Register Visual Studio as a Generator
 
 - Open `x64 Native Tools Command Prompt`
 - Run `cmake`
 - Close the cmd window
 
-## Building
+## 🔨 Building
+
+[Create a new github repo from this template](https://github.com/new?template_name=PluginTemplate&template_owner=gottyduke) or: 
 
 ```
 git clone https://github.com/gottyduke/PluginTemplate.git
@@ -31,10 +53,10 @@ git submodule update --remote
 .\build-release.ps1
 ```
 
-## License
+## 📖 License
 
 [MIT](LICENSE)
 
-## Credits
+## ❓ Credits
 
 - [Ryan for his commonLibSSE code](https://github.com/Ryan-rsm-McKenzie/CommonLibSSE) which was referenced in DKUtil.