extern/PowerShell
1
0
Fork 0
mirror of https://github.com/fleschutz/PowerShell.git synced 2024-12-15 19:21:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update FAQ.md

Browse Source
This commit is contained in:
Markus Fleschutz 2023-05-10 14:12:49 +02:00 committed by GitHub
parent 6536e0a28f
commit c4a50bc586
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
Docs/FAQ.md
View File

@ -71,22 +71,23 @@ Make sure PowerShell is installed, then execute: `chsh -s /usr/bin/pwsh <usernam
Execute: `./set-profile.ps1` in the *Scripts* subfolder, this will install **my-profile.ps1** as your PowerShell profile. It's a nice looking base profile, but can easily be changed to your needs. Execute: `./set-profile.ps1` in the *Scripts* subfolder, this will install **my-profile.ps1** as your PowerShell profile. It's a nice looking base profile, but can easily be changed to your needs.
</details> </details>
How to add the scripts to the search path? <details><summary>How to add the scripts to the search path?</summary>
------------------------------------------
Want to use the PowerShell scripts everywhere on the command-line? Then you need to add the Scripts/ subfolder to the search path: Want to use the PowerShell scripts everywhere on the command-line? Then you need to add the Scripts/ subfolder to the search path:
* **On Linux using Bash:** edit .profile in your home directory and add the line: PATH="$PATH:/path/to/PowerShell/Scripts" * **On Linux using Bash:** edit .profile in your home directory and add the line: PATH="$PATH:/path/to/PowerShell/Scripts"
* **On Windows:** open Settings > System > About > Advanced system settings > Environment Variables, edit the user's variable "Path", and add the full path to the Scripts/ directory. * **On Windows:** open Settings > System > About > Advanced system settings > Environment Variables, edit the user's variable "Path", and add the full path to the Scripts/ directory.
</details>
<details><summary>How to use PowerShell in Windows context menus?</summary>
How to use PowerShell in Windows context menus?
-----------------------------------------------
* to enable "right-click > New > Windows PowerShell Script" execute `Add_ps1_to_New_context_menu.reg` in subfolder [Data/](../Data) * to enable "right-click > New > Windows PowerShell Script" execute `Add_ps1_to_New_context_menu.reg` in subfolder [Data/](../Data)
* to disable this execute `Remove_ps1_from_New_context_menu.reg` in subfolder [Data/](../Data) * to disable this execute `Remove_ps1_from_New_context_menu.reg` in subfolder [Data/](../Data)
</details>
Which editor to use for PowerShell scripts? <details><summary>Which editor to use for PowerShell scripts?</summary>
-------------------------------------------
* **Visual Studio Code** - Supporting syntax highlighting, on-the-fly problem checking and an integrated PowerShell Console (available for free on Linux, Mac OS and Windows, now recommended by Microsoft). * **Visual Studio Code** - Supporting syntax highlighting, on-the-fly problem checking and an integrated PowerShell Console (available for free on Linux, Mac OS and Windows, now recommended by Microsoft).
* **PowerShell ISE** (Integrated Scripting Environment) - Former official PowerShell development environment included with Microsoft Windows. * **PowerShell ISE** (Integrated Scripting Environment) - Former official PowerShell development environment included with Microsoft Windows.
* **PowerShell Studio** - Powerful PowerShell IDE with module, help, and user interface development tools, high DPI support and regular updates. * **PowerShell Studio** - Powerful PowerShell IDE with module, help, and user interface development tools, high DPI support and regular updates.
@ -94,10 +95,10 @@ Which editor to use for PowerShell scripts?
* **Atom package** - Add-on with PowerShell language support for Atom. * **Atom package** - Add-on with PowerShell language support for Atom.
* **SublimeText package** - Add-on with PowerShell language support for Sublime Text. * **SublimeText package** - Add-on with PowerShell language support for Sublime Text.
* or your **favorite text editor** as an alternative. * or your **favorite text editor** as an alternative.
</details>
<details><summary>How to write good PowerShell scripts?</summary>
How to write good PowerShell scripts?
-------------------------------------
Good PowerShell scripts are both user-friendly and platform-independent. I recommend the following rules as a starting point: Good PowerShell scripts are both user-friendly and platform-independent. I recommend the following rules as a starting point:
1. Use the `<verb>-<object>.ps1` scheme to name the script. 1. Use the `<verb>-<object>.ps1` scheme to name the script.
@ -109,20 +110,19 @@ Good PowerShell scripts are both user-friendly and platform-independent. I recom
7. For readibility use UpperCamelCase for variables and functions, lowerCamelCase for everything else. 7. For readibility use UpperCamelCase for variables and functions, lowerCamelCase for everything else.
8. Set *execute* file permissions for Linux: `chmod a+rx <filename>` 8. Set *execute* file permissions for Linux: `chmod a+rx <filename>`
9. On success exit with error code 0 (`exit 0`), otherwise print the error with keyword "ERROR:" (to support log parsers) and exit the error code (mostly 1) 9. On success exit with error code 0 (`exit 0`), otherwise print the error with keyword "ERROR:" (to support log parsers) and exit the error code (mostly 1)
</details>
<details><summary>Where's the Star History?</summary>>
Where's the Star History?
-------------------------
[![Star History Chart](https://api.star-history.com/svg?repos=fleschutz/PowerShell&type=Date)](https://star-history.com/#fleschutz/PowerShell&Date) [![Star History Chart](https://api.star-history.com/svg?repos=fleschutz/PowerShell&type=Date)](https://star-history.com/#fleschutz/PowerShell&Date)
</details>
<details><summary>Want to contribute or found a bug or issue?</summary>
Want to contribute or found a bug or issue?
-------------------------------------------
If you find something bad (like a bug, error, or any issue), please report it here by open an Issue. If you find something bad (like a bug, error, or any issue), please report it here by open an Issue.
Or even better: Fork the repository, add or fix the script and submit a pull request, so others can participate too. Or even better: Fork the repository, add or fix the script and submit a pull request, so others can participate too.
</details>
<details><summary>Your question is not answered here?</summary>
Your question is not answered here?
-----------------------------------
Send your question to: markus.fleschutz [at] gmail.com Send your question to: markus.fleschutz [at] gmail.com
</details>