From fdd40730c25c3fff8fa1c01d415597ce093bb0c4 Mon Sep 17 00:00:00 2001 From: Markus Fleschutz Date: Mon, 30 Nov 2020 15:37:02 +0000 Subject: [PATCH] Updated README.md --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8f784aae..13b8949f 100644 --- a/README.md +++ b/README.md @@ -80,16 +80,17 @@ How to add the subfolder Scripts/ to the search path for command-line usage? * **Windows:** open the environment variables dialogue and add the full path to Scripts/ to the system environment variable "Path" * **Bash or sh:** edit .profile in your home directory and add the line: PATH="$PATH:/path/to/PowerShell/Scripts" -Script Standards +Conventions Used ---------------- -Each script should support the following rules: +Each PowerShell script should follow the 7 golden rules: -* **Rule 1:** to support PowerShell on Linux the first line reads: #!/snap/bin/powershell -* **Rule 2:** to support PowerShell on Linux the script has execute file permissions (chmod a+rx ) -* **Rule 3:** add a metadata header containing the syntax, description, author, source, and license -* **Rule 4:** prefer command-line options, but may ask the user in case no option is given -* **Rule 5:** the encoding of the script is in UTF-8 with BOM to support Unicode characters -* **Rule 6:** exit 0 for success, otherwise exit with the error code (mostly 1) +* **Rule 1:** the script filename should be named "-.ps1" +* **Rule 2:** to support PowerShell on Linux the first line reads: #!/snap/bin/powershell +* **Rule 3:** to support PowerShell on Linux the script has execute file permissions (chmod a+rx ) +* **Rule 4:** add a metadata header containing the syntax, description, author, source, and license +* **Rule 5:** prefer command-line options, but may ask the user in case no option is given +* **Rule 6:** the encoding of the script is in UTF-8 with BOM to support Unicode characters +* **Rule 7:** exit 0 for success, otherwise exit with the error code (mostly 1) Feedback --------