Add extra documentation for new post-setup scripts

xcellerator · Nov 12, 2017 · 95d4083 · 95d4083
1 parent d378b71
commit 95d4083
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/config/options.txt b/config/options.txt
@@ -8,6 +8,11 @@
 #   storage
 gadget: serial
 
+# Can be any script or executable on the filesystem.
+# Either an absolute path or a path relative to `/boot/usbninja/` will work
+# The executable bit must also be set. See Documentation for details.
+post: changeme
+
 # Can be any 2 byte hex value in the form of 0x????.
 vendorid: 0x1d6b
 

diff --git a/doc/OPTIONS.md b/doc/OPTIONS.md
@@ -26,6 +26,7 @@ productname: Composite USB Device
 |`productname`|The Product Name string reported to the Host OS|Up to 32 characters long|`USB Device`|
 
 **Note: The `post` script can be either an absolute path or a path relative to `/boot/usbninja/`.**
+**Note: The `post` script must also have the executable bit set with `sudo chmod +x /path/to/file`.**
 
 ### Settings available to certain gadgets
 |Option|Gadget|Description|Format|Default Value|