From a85a8ddc97d489cd85b9bb8508d6200a42bf392b Mon Sep 17 00:00:00 2001
From: modeco80 <lily.modeco80@protonmail.ch>
Date: Wed, 19 Jul 2023 06:31:07 -0400
Subject: [PATCH] add helper to build module and install it.

---
 README.md       | 2 ++
 build_module.sh | 4 ++--
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index db0bd1a..338057a 100644
--- a/README.md
+++ b/README.md
@@ -34,6 +34,8 @@ garrysmod/addons/lcpu$ [[ ! -d '../../lua/bin']] && mkdir -p ../../lua/bin && cp
 # Tada!
 ```
 
+On Linux you can alternatively use the `./build_module.sh` script that will do all the build and installation steps automatically.
+
 
 # Special Thanks
 
diff --git a/build_module.sh b/build_module.sh
index e0c2d28..27b654a 100755
--- a/build_module.sh
+++ b/build_module.sh
@@ -1,11 +1,11 @@
 #!/bin/bash
 
-
 # Build the LCPU addon for the reccomended environment
+# and install it into the proper directory gmod wants native modules to be.
+# This expects to be ran in [gmod]/addons/[addon folder].
 
 set -x
 
-
 cmake -Wno-dev -GNinja -S native -B build -DCMAKE_BUILD_TYPE=Release
 ninja -C build