extern/PowerShell
1
0
Fork 0
mirror of https://github.com/fleschutz/PowerShell.git synced 2024-11-22 16:03:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Markus Fleschutz 2020-10-03 23:43:59 +02:00 committed by GitHub
parent b74d2f347d
commit d55bc441c2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -3,8 +3,10 @@ Collection of Useful PowerShell Scripts (CUPS)
Useful cross-platform PowerShell scripts, to be used on the command-line (CLI) or by automation software like Jenkins.
PowerShell Scripts Included
---------------------------
List of Scripts
---------------
The following PowerShell scripts can be found in the Scripts/ subfolder:
* [download.ps1](Scripts/download.ps1) - downloads the file/directory from the given URL
* [exe_info.ps1](Scripts/exe_info.ps1) - prints basic information of the given executable file
* [lscmdlets.ps1](Scripts/lscmdlets.ps1) - lists all PowerShell cmdlets
@ -68,11 +70,13 @@ How to add the subfolder Scripts/ to the search path for command-line usage?
Script Standards
----------------
Each script supports the following:
1. **a metadata header** containing the syntax, description, author, source, and license
2. **prefers command-line options** but may ask the user in case no option is given
3. **encoding in UTF-8 with BOM** to support Unicode characters
4. **exits 0 for success**, otherwise the error code (mostly 1)
Each script should support the following rules:
* **Rule 1:** to support PowerShell on Linux the first line reads: #!/snap/bin/powershell
* **Rule 2:** a metadata header containing the syntax, description, author, source, and license
* **Rule 3:** prefer command-line options, but may ask the user in case no option is given
* **Rule 4:** the script encoding is in UTF-8 with BOM to support Unicode characters
* **Rule 5:** the script exits with "exit 0" for success* otherwise the error code (mostly 1)
Feedback
--------