Change a few things

StrangeRanger · StrangeRanger · commit a2beeeb5f5b3 · 2021-03-14T12:42:51.000-07:00
diff --git a/Examples/example-1.md b/Examples/example-1.md
@@ -4,81 +4,69 @@ The code below is from an installer project that can be refered to at this link:
 
 ```bash
 #!/bin/bash
-
-################################################################################
 #
 # linuxAIO acts as the intermediary between the system NadekoBot is being hosted
 # on and the 'installer_prep.sh'. To prevent any conflicts with updates to
 # the installer, this script has as little code as deemed necessary.
 #
 ################################################################################
-#
-# [ Development Variables ]
-#
-# The variables below are for dev/testing purpouses (DO NOT MODIFY).
-#
-###
-    export linuxAIO_revision="5"                                # Keeps track of changes to linuxAIO.sh
-    export installer_repo="StrangeRanger/NadekoBot-BashScript"  # Determines which repo is used
-###
-#
-# End of [ Development Variables ]
-################################################################################
+#### [ Development Variables ]
+#### The variables below are for dev/testing purpouses (!!! DO NOT MODIFY !!!).
+
+
+export linuxAIO_revision="8"                                # Keeps track of changes to linuxAIO.sh
+export installer_repo="StrangeRanger/NadekoBot-BashScript"  # Determines which repo is used
 
 
+#### End of [ Development Variables ]
 ################################################################################
+#### [ Configuration Variables ]
+#### The variables below are used to modify some of the actions of the installer
+#### and CAN BE modified by the end user.
+
+
+# Determines from which branch the installer will use.
+# release/latest = The latest release
+# master         = The latest stable code
+# dev            = Non-production ready code (may break your system)
 #
-# [ Configuration Varaibles ]
-#
-# The variables below are used to configure the installer in one way or another,
-# and CAN BE modified by the end user.
-#
-###
-    # Determines from which branch from the installer repo will be used
-    # release/latest = The most recent release
-    # master         = The latest stable code
-    # dev            = Non-production ready code (may break your system)
-    # 
-    # Default: release/latest
-    export installer_branch="release/latest"
-
-    # Determines whether or not the installer can be run as the root user:
-    # true = can be run with root privilege
-    # false = cannot be run with root privilege (recommended)
-    #
-    # Default: false
-    allow_run_as_root=false
-###
+# Default: master
+export installer_branch="master"
+
+# Determines whether or not the installer can be run as the root user:
+# true  = can be run with root privilege
+# false = cannot be run with root privilege (recommended)
 #
-# End of [ Configuration Varaibles ]
-################################################################################
+# Default: false
+allow_run_as_root=false
 
 
+#### End of [ Configuration Variables ]
 ################################################################################
-#
-# [ Main ]
-#
-###
-    # Checks if the script was executed with root privilege
-    if ((EUID == 0)) && [[ $allow_run_as_root = false ]]; then
-        echo "\033[1;31mPlease run this script without root privilege" >&2
-        echo "\033[0;36mWhile you will be performing specific tasks with root" \
-            "priviledge running the installer in it's entirety as root is not" \
-            "recommended\033[0m"
-        echo -e "\nExiting..."
-        exit 1
-    fi
-
-    echo "Downloading the latest installer..."
-    curl https://raw.githubusercontent.com/"$installer_repo"/"$installer_branch"/installer_prep.sh \
-            -o installer_prep.sh || {
-        echo "Failed to download 'installer_prep.sh'..." >&2
-        echo -e "\nExiting..."
-        exit 1
-    }
-    sudo chmod +x installer_prep.sh && ./installer_prep.sh
-###
-#
-# End of [ Main ]
+#### [ Main ]
+
+
+# Checks if the script was executed with root privilege
+if ((EUID == 0)) && [[ $allow_run_as_root = false ]]; then
+    echo "\033[1;31mPlease run this script without root privilege" >&2
+    echo "\033[0;36mWhile you will be performing specific tasks with root" \
+        "priviledge, running the installer in it's entirety as root is not" \
+        "recommended\033[0m"
+    echo -e "\nExiting..."
+    exit 1
+fi
+
+echo "Downloading the latest installer..."
+curl https://raw.githubusercontent.com/"$installer_repo"/"$installer_branch"/installer_prep.sh \
+        -o installer_prep.sh || {
+    echo "Failed to download 'installer_prep.sh'..." >&2
+    echo -e "\nExiting..."
+    exit 1
+}
+sudo chmod +x installer_prep.sh && ./installer_prep.sh
+
+
+#### End of [ Main ]
 ################################################################################
+
 ```
diff --git a/Examples/example-2.md b/Examples/example-2.md
diff --git a/README.md b/README.md
@@ -87,7 +87,7 @@ fi
 
 ### Spacing
 
-No more than two consecutive newline characters, meaning no more than one blank line. The only time two blank lines are acceptable is in between the section comments described in the `Commenting/File Formatting` section below.
+No more than three consecutive newline characters, meaning no more than two blank lines.
 
 ### Comments
 
@@ -100,76 +100,9 @@ box="Box"           # This is a box       (Aligned with the comment above for be
 
 ### Commenting/File Formatting
 
-Though not required, it is preferred to follow the comment/file formatting described below.
+There is no required way to format your comments and files. That said, stay consistent with the chosen style.
 
-If your file is fairly big and has many parts (variables, error trapping, functions, main code, etc.), then the comments and overall formatting should look similar to below:
-
-``` bash
-#!/bin/bash
-
-################################################################################
-#
-# File description
-#
-################################################################################
-#
-# [ Variables ]
-#
-###
-    var=var
-###
-#
-# End of [ Variables ]
-################################################################################
-
-
-################################################################################
-#
-# [ Functions ]
-#
-###
-    func() {
-        ...
-    }
-###
-#
-# End of [ Functions ]
-################################################################################
-
-
-################################################################################
-#
-# [ Main ]
-#
-###
-    ...
-    ...
-    ...
-###
-#
-# End of [ Main ]
-################################################################################
-```
-
-Though if your file is fairly small and doesn't have many parts (variables, functions, etc.), then the comments and overall formatting should look similar to below:
-
-``` bash
-#!/bin/bash
-
-################################################################################
-#
-# File description
-#
-################################################################################
-#
-    var=var
-    ...
-    ...
-```
-
-If you don't know which formatting to use based on your situation, use your best judgment.
-
-Refer to these files for examples: [example 1](Examples/example-1.md) and [example 2](Examples/example-2.md).
+An example of my own style can be found in [example 1](Examples/example-1.md).
 
 ## Bashisms
 
