Merge branch 'master' of github.com:ajmwagar/laat

README.md

@@ -38,6 +38,44 @@ Sign your PBOs with `laat pack --sign` or `laat sign`
 
 Release to the Steam workshop with `laat release -u <steam user> -p <steam pass> -g <steam guard code>`
 
+### GitHub Actions
+
+Since LAAT, by-default, doesn't require any extra tooling, you can run it in GitHub actions and automatically build and release your mod to the Steam Workshop.
+
+```yml
+name: Build and Release with LAAT
+
+on:
+  # Triggers the workflow on push or pull request events but only for the master branch
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checks-out your repository
+      - uses: actions/checkout@v2
+
+      # Build, Pack, and Sign using LAAT
+      - uses: ajmwagar/[email protected]
+        with:
+          command: ship
+
+      # Release the mod to the Steam Workshop
+      - uses: ajmwagar/[email protected]
+        with:
+          command: release
+          args: -u ${{ secrets.STEAM_USER }} -p ${{ secrets.STEAM_PASS }} --no-change-log
+```
+
 ## Configuration
 
 Currently you configure the bulk of LAAT via the `LAAT.toml` file.
@@ -94,6 +132,25 @@ A LAAT Project might look like the following:
    └── @17th
 ```
 
+## Developing with LAAT
+
+The development workflow with LAAT adds a new step.
+
+We call it the "build" step, which comes before PBO packing.
+
+Think of the "build" step as another developer who is working on the project with you. It will generate code and addons and add them to the `build` folder.
+
+---
+
+The workflow for people who are building normal addons doesn't change, However, we have removed the P:/ drive.
+
+The steps in the pipeline are as follows:
+- `build`: LAAT generates your addons
+- `pack`: LAAT uses `armake2` to pack your addons into PBOs.
+- `sign`: LAAT signs your PBOs using your `.biprivatekey` file.
+- `release`: LAAT used `steamcmd` to upload your mod to the Steam Workshop.
+
+
 ## Compiler Plugins
 
 Plugins are what take your assets and configuration file, and turn them into valid Arma 3 Mod Addons (i.e. the things you build into PBOs)