extern/PowerShell
1
0
Fork 0
mirror of https://github.com/fleschutz/PowerShell.git synced 2024-10-05 09:31:58 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Markus Fleschutz 2020-12-08 21:25:56 +01:00 committed by GitHub
parent 4485389295
commit c27eca9ea4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -49,9 +49,9 @@ The following PowerShell scripts can be found in the [Scripts/](Scripts/) subfol
* [wakeup.ps1](Scripts/wakeup.ps1) - sends a magic packet to the given computer, waking him up
* [zip-dir.ps1](Scripts/zip-dir.ps1) - creates a zip archive of the given folder
What is PowerShell?
-------------------
PowerShell is a task automation and configuration management framework from Microsoft, consisting of a command-line shell and associated scripting language.
* it's **cross-platform**: available for Linux, Mac OS and Windows
* it's **powerful**: fully control your computer
@ -70,24 +70,28 @@ Afterward, install the scripts by clicking on the green "Code" button or execute
$ git clone https://github.com/fleschutz/PowerShell
```
How to configure PowerShell as default shell on Linux?
------------------------------------------------------
Make sure PowerShell is installed, then use the `chsh` commmand as follows:
* `chsh -s /bin/powershell <username>`
Configure PowerShell as Default Shell
-------------------------------------
* **Linux:** make sure PowerShell is installed, then execute: `chsh -s /snap/bin/powershell <username>`
* **Windows:** no need to, PowerShell is the default shell
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"
Adding Subfolder Scripts/ to the Search Path for Command-line Usage
-------------------------------------------------------------------
* **Bash or sh:** edit .profile in your home directory and add the line: PATH="$PATH:/path/to/PowerShell/Scripts"
* **Windows:** open the environment variables dialogue and add the full path to Scripts/ to the system environment variable "Path"
Conventions Used
----------------
Using PowerShell in Windows Context Menus
------------------------------------------
* to enable "right-click > New > Windows PowerShell Script" just execute Context_Menus/add_ps1_to_New_context_menu.reg
* to disable it just execute Context_Menus/remove_ps1_from_New_context_menu.reg
Script Conventions
------------------
Each PowerShell script should follow the 7 golden rules:
* **Rule 1:** the script filename should be named `<verb>-<object>.ps1`
* **Rule 1:** the filename should be named `<verb>-<object>.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 <file>)
* **Rule 4:** add a metadata header containing the syntax, description, author, source, and license