mirrors/PowerShell
0
0
Fork 0
mirror of https://github.com/PowerShell/PowerShell.git synced 2024-11-27 11:56:14 +08:00
Code Issues Packages Projects Releases Wiki Activity
7f9b118dc0
PowerShell/README.md

246 lines
19 KiB
Markdown
Raw Normal View History

Fix Markdown lint issues (#3357) * Fix Markdown lint issues Make header styles consistent Make header names unique (make anchors usable) * Fix spelling of sign up * Add words used in readme to spelling dictionary.
2017-03-22 06:20:11 +08:00
# ![logo][] PowerShell
Add a readme
2015-07-02 06:06:29 +08:00
Fix typo in readme
2016-08-18 23:55:00 +08:00
Welcome to the PowerShell GitHub Community!
Added section explaining Windows PowerShell vs PowerShell Core (#4186)
2017-07-09 06:20:09 +08:00
PowerShell Core is a cross-platform (Windows, Linux, and macOS) automation and configuration tool/framework that works well with your existing tools and is optimized
for dealing with structured data (e.g. JSON, CSV, XML, etc.), REST APIs, and object models.
It includes a command-line shell, an associated scripting language and a framework for processing cmdlets.
Rewrite README
2016-07-28 05:47:03 +08:00
change logo to SVG (#6072) Current README uses a PNG which doesn't scale for high dpi displays (starts to look fuzzy). Created 64 pixel wide version of svg of the black logo and inserted into README.md. Note that it currently doesn't render as the absolute URL points to master so that it gets rendered correctly in other places where the README.md is used (like docker hub).
2018-02-03 10:35:59 +08:00
[logo]: https://raw.githubusercontent.com/PowerShell/PowerShell/master/assets/ps_black_64.svg?sanitize=true
Add build instructions matrix to readme
2016-03-31 06:13:29 +08:00
README.md (#9045) Added punctuations wherever necessary.
2019-03-12 06:20:36 +08:00
## Windows PowerShell vs. PowerShell Core
Added section explaining Windows PowerShell vs PowerShell Core (#4186)
2017-07-09 06:20:09 +08:00
Merged PR 3912: Update package versions for the new release
2018-07-20 06:15:44 +08:00
Although this repository started as a fork of the Windows PowerShell code base, changes made in this repository do not make their way back to Windows PowerShell 5.1 automatically.
Update README.md (#11100) Link to issues page added, reference to version 6 changed to "6 and higher"
2019-11-19 12:22:12 +08:00
This also means that [issues tracked here][issues] are only for PowerShell Core 6 and higher.
Added section explaining Windows PowerShell vs PowerShell Core (#4186)
2017-07-09 06:20:09 +08:00
Windows PowerShell specific issues should be opened on [UserVoice][].
Update README.md (#11100) Link to issues page added, reference to version 6 changed to "6 and higher"
2019-11-19 12:22:12 +08:00
[issues]: https://github.com/PowerShell/PowerShell/issues
Added section explaining Windows PowerShell vs PowerShell Core (#4186)
2017-07-09 06:20:09 +08:00
[UserVoice]: https://windowsserver.uservoice.com/forums/301869-powershell
Fix Markdown lint issues (#3357) * Fix Markdown lint issues Make header styles consistent Make header names unique (make anchors usable) * Fix spelling of sign up * Add words used in readme to spelling dictionary.
2017-03-22 06:20:11 +08:00
## New to PowerShell?
Add build instructions matrix to readme
2016-03-31 06:13:29 +08:00
Rewrite README
2016-07-28 05:47:03 +08:00
If you are new to PowerShell and would like to learn more, we recommend reviewing the [getting started][] documentation.
Add AppVeyor CI integration. AppVeyor is a cloud-based CI platform for windows. Use [skip ci] tag in any place of message to mark commit as trivial (i.e. README.md changes).
2016-01-23 03:36:23 +08:00
Change all links in README.md to absolute as it is being reused in other places outside of GitHub (#5354)
2017-11-07 02:29:49 +08:00
[getting started]: https://github.com/PowerShell/PowerShell/tree/master/docs/learning-powershell
Refactor readme header
2016-03-31 03:06:57 +08:00
Fix Markdown lint issues (#3357) * Fix Markdown lint issues Make header styles consistent Make header names unique (make anchors usable) * Fix spelling of sign up * Add words used in readme to spelling dictionary.
2017-03-22 06:20:11 +08:00
## Get PowerShell
Add build instructions matrix to readme
2016-03-31 06:13:29 +08:00
Rewrite README
2016-07-28 05:47:03 +08:00
You can download and install a PowerShell package for any of the following platforms.
Update `README.md` and `metadata.json` for the next release (#11992)
2020-03-05 01:32:21 +08:00
| Supported Platform | Download (LTS) | Downloads (stable) | Downloads (preview) | How to Install |
| -------------------------------------------| ------------------------| ------------------------| ----------------------| ------------------------------|
| [Windows (x64)][corefx-win] | [.msi][rl-windows-64] | [.msi][rl-windows-64] | [.msi][pv-windows-64] | [Instructions][in-windows] |
| [Windows (x86)][corefx-win] | [.msi][rl-windows-86] | [.msi][rl-windows-86] | [.msi][pv-windows-86] | [Instructions][in-windows] |
| [Ubuntu 18.04][corefx-linux] | [.deb][lts-ubuntu18] | [.deb][rl-ubuntu18] | [.deb][pv-ubuntu18] | [Instructions][in-ubuntu18] |
| [Ubuntu 16.04][corefx-linux] | [.deb][lts-ubuntu16] | [.deb][rl-ubuntu16] | [.deb][pv-ubuntu16] | [Instructions][in-ubuntu16] |
| [Debian 9][corefx-linux] | [.deb][lts-debian9] | [.deb][rl-debian9] | [.deb][pv-debian9] | [Instructions][in-deb9] |
| [Debian 10][corefx-linux] | [.deb][lts-debian10] | [.deb][rl-debian10] | [.deb][pv-debian10] | |
| [CentOS 7][corefx-linux] | [.rpm][lts-centos] | [.rpm][rl-centos] | [.rpm][pv-centos] | [Instructions][in-centos] |
| [CentOS 8][corefx-linux] | [.rpm][lts-centos8] | [.rpm][rl-centos8] | [.rpm][pv-centos8] | |
| [Red Hat Enterprise Linux 7][corefx-linux] | [.rpm][lts-centos] | [.rpm][rl-centos] | [.rpm][pv-centos] | [Instructions][in-rhel7] |
| [openSUSE 42.3][corefx-linux] | [.rpm][lts-centos] | [.rpm][rl-centos] | [.rpm][pv-centos] | [Instructions][in-opensuse] |
| [Fedora 30][corefx-linux] | [.rpm][lts-centos] | [.rpm][rl-centos] | [.rpm][pv-centos] | [Instructions][in-fedora] |
| [macOS 10.13+][corefx-macos] | [.pkg][lts-macos] | [.pkg][rl-macos] | [.pkg][pv-macos] | [Instructions][in-macos] |
| Docker | | | | [Instructions][in-docker] |
Update scripts and documentation with RC.2 version (#5688)
2017-12-15 05:15:19 +08:00
You can download and install a PowerShell package for any of the following platforms, **which are supported by the community.**
Update docs for v6.1.0-preview.1 release (#6481) * Update docs * Added the missing 'stable' label
2018-03-24 07:48:24 +08:00
| Platform | Downloads (stable) | Downloads (preview) | How to Install |
| -------------------------| ------------------------| ----------------------------- | ------------------------------|
| Arch Linux | | | [Instructions][in-archlinux] |
| Kali Linux | [.deb][rl-ubuntu16] | [.deb][pv-ubuntu16] | [Instructions][in-kali] |
Merged PR 3912: Update package versions for the new release
2018-07-20 06:15:44 +08:00
| Many Linux distributions | [Snapcraft][rl-snap] | [Snapcraft][pv-snap] | |
Update installation doc and README.md to include the powershell binary archive packages (#5212) * Update README.md * Update docs for powershell binary archive packages * Update the chart
2017-10-25 02:13:17 +08:00
You can also download the PowerShell binary archives for Windows, macOS and Linux.
Update `README.md` removing experimental status of `Arm` builds, but `Win-Arm64` is still preview for Stable release. (#12707)
2020-05-20 02:10:43 +08:00
| Platform | Downloads (stable) | Downloads (preview) | How to Install |
| ---------------| --------------------------------------------------- | ------------------------------------------------| -----------------------------------------------|
| Windows | [32-bit][rl-winx86-zip]/[64-bit][rl-winx64-zip] | [32-bit][pv-winx86-zip]/[64-bit][pv-winx64-zip] | [Instructions][in-windows-zip] |
| macOS | [64-bit][rl-macos-tar] | [64-bit][pv-macos-tar] | [Instructions][in-tar-macos] |
| Linux | [64-bit][rl-linux-tar] | [64-bit][pv-linux-tar] | [Instructions][in-tar-linux] |
| Windows (Arm) | [32-bit][rl-winarm]/[64-bit][rl-winarm64] (preview) | [32-bit][pv-winarm]/[64-bit][pv-winarm64] | [Instructions][in-arm] |
| Raspbian (Arm) | [32-bit][rl-arm32]/[64-bit][rl-arm64] | [32-bit][pv-arm32]/[64-bit][pv-arm64] | [Instructions][in-raspbian] |
Update `README.md` and `metadata.json` for the next release (#11992)
2020-03-05 01:32:21 +08:00
Update `README.md` and `metadata.json` for the v7.0.3 release (#13187)
2020-07-17 03:10:27 +08:00
[lts-ubuntu18]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-lts_7.0.3-1.ubuntu.18.04_amd64.deb
[lts-ubuntu16]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-lts_7.0.3-1.ubuntu.16.04_amd64.deb
[lts-debian9]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-lts_7.0.3-1.debian.9_amd64.deb
[lts-debian10]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-lts_7.0.3-1.debian.10_amd64.deb
[lts-centos]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-lts-7.0.3-1.rhel.7.x86_64.rpm
[lts-centos8]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-lts-7.0.3-1.centos.8.x86_64.rpm
[lts-macos]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-lts-7.0.3-osx-x64.pkg
[rl-windows-64]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/PowerShell-7.0.3-win-x64.msi
[rl-windows-86]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/PowerShell-7.0.3-win-x86.msi
[rl-ubuntu18]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell_7.0.3-1.ubuntu.18.04_amd64.deb
[rl-ubuntu16]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell_7.0.3-1.ubuntu.16.04_amd64.deb
[rl-debian9]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell_7.0.3-1.debian.9_amd64.deb
[rl-debian10]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell_7.0.3-1.debian.10_amd64.deb
[rl-centos]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-7.0.3-1.rhel.7.x86_64.rpm
[rl-centos8]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-7.0.3-1.centos.8.x86_64.rpm
[rl-macos]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-7.0.3-osx-x64.pkg
[rl-winarm]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/PowerShell-7.0.3-win-arm32.zip
[rl-winarm64]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/PowerShell-7.0.3-win-arm64.zip
[rl-winx86-zip]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/PowerShell-7.0.3-win-x86.zip
[rl-winx64-zip]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/PowerShell-7.0.3-win-x64.zip
[rl-macos-tar]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-7.0.3-osx-x64.tar.gz
[rl-linux-tar]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-7.0.3-linux-x64.tar.gz
[rl-arm32]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-7.0.3-linux-arm32.tar.gz
[rl-arm64]: https://github.com/PowerShell/PowerShell/releases/download/v7.0.3/powershell-7.0.3-linux-arm64.tar.gz
Merged PR 3912: Update package versions for the new release
2018-07-20 06:15:44 +08:00
[rl-snap]: https://snapcraft.io/powershell
Update `README.md` and `metadata.json` for next release (#13059)
2020-07-07 06:08:42 +08:00
[pv-windows-64]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0-preview.5/PowerShell-7.1.0-preview.5-win-x64.msi
[pv-windows-86]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0-preview.5/PowerShell-7.1.0-preview.5-win-x86.msi
[pv-ubuntu18]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0-preview.5/powershell-preview_7.1.0-preview.5-1.ubuntu.18.04_amd64.deb
[pv-ubuntu16]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0-preview.5/powershell-preview_7.1.0-preview.5-1.ubuntu.16.04_amd64.deb
[pv-debian9]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0-preview.5/powershell-preview_7.1.0-preview.5-1.debian.9_amd64.deb
[pv-debian10]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0-preview.5/powershell-preview_7.1.0-preview.5-1.debian.10_amd64.deb
[pv-centos]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0-preview.5/powershell-preview-7.1.0_preview.5-1.rhel.7.x86_64.rpm
[pv-centos8]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0-preview.5/powershell-preview-7.1.0_preview.5-1.centos.8.x86_64.rpm
[pv-macos]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0-preview.5/powershell-7.1.0-preview.5-osx-x64.pkg
[pv-winarm]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0-preview.5/PowerShell-7.1.0-preview.5-win-arm32.zip
[pv-winarm64]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0-preview.5/PowerShell-7.1.0-preview.5-win-arm64.zip
[pv-winx86-zip]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0-preview.5/PowerShell-7.1.0-preview.5-win-x86.zip
[pv-winx64-zip]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0-preview.5/PowerShell-7.1.0-preview.5-win-x64.zip
[pv-macos-tar]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0-preview.5/powershell-7.1.0-preview.5-osx-x64.tar.gz
[pv-linux-tar]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0-preview.5/powershell-7.1.0-preview.5-linux-x64.tar.gz
[pv-arm32]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0-preview.5/powershell-7.1.0-preview.5-linux-arm32.tar.gz
[pv-arm64]: https://github.com/PowerShell/PowerShell/releases/download/v7.1.0-preview.5/powershell-7.1.0-preview.5-linux-arm64.tar.gz
Merged PR 3912: Update package versions for the new release
2018-07-20 06:15:44 +08:00
[pv-snap]: https://snapcraft.io/powershell-preview
Update docs for v6.1.0-preview.1 release (#6481) * Update docs * Added the missing 'stable' label
2018-03-24 07:48:24 +08:00
Update docs.microsoft.com links (#12653) # PR Summary * remove explicit en-us from links * remove view parameter ## PR Context follow-up #7013 ## PR Checklist - [x] [PR has a meaningful title](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - Use the present tense and imperative mood when describing your changes - [x] [Summarized changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [x] [Make sure all `.h`, `.cpp`, `.cs`, `.ps1` and `.psm1` files have the correct copyright header](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [x] This PR is ready to merge and is not [Work in Progress](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---work-in-progress). - If the PR is work in progress, please add the prefix `WIP:` or `[ WIP ]` to the beginning of the title (the `WIP` bot will keep its status check at `Pending` while the prefix is present) and remove the prefix when the PR is ready. - **[Breaking changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#making-breaking-changes)** - [ ] None - **OR** - [ ] [Experimental feature(s) needed](https://github.com/MicrosoftDocs/PowerShell-Docs/blob/staging/reference/6/Microsoft.PowerShell.Core/About/about_Experimental_Features.md) - [ ] Experimental feature name(s): <!-- Experimental feature name(s) here --> - **User-facing changes** - [x] Not Applicable - **OR** - [ ] [Documentation needed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [ ] Issue filed: <!-- Number/link of that issue here --> - **Testing - New and feature** - [x] N/A or can only be tested interactively - **OR** - [ ] [Make sure you've added a new test if existing tests do not effectively test the code changed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#before-submitting) - **Tooling** - [x] I have considered the user experience from a tooling perspective and don't believe tooling will be impacted. - **OR** - [ ] I have considered the user experience from a tooling perspective and enumerated concerns in the summary. This may include: - Impact on [PowerShell Editor Services](https://github.com/PowerShell/PowerShellEditorServices) which is used in the [PowerShell extension](https://github.com/PowerShell/vscode-powershell) for VSCode (which runs in a different PS Host). - Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features. - Impact on [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer) (which provides linting & formatting in the editor extensions). - Impact on [EditorSyntax](https://github.com/PowerShell/EditorSyntax) (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
2020-05-15 11:29:43 +08:00
[in-windows]: https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-windows
[in-ubuntu16]: https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-linux#ubuntu-1604
[in-ubuntu18]: https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-linux#ubuntu-1804
[in-deb9]: https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-linux#debian-9
[in-centos]: https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-linux#centos-7
[in-rhel7]: https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-linux#red-hat-enterprise-linux-rhel-7
[in-opensuse]: https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-linux#opensuse
[in-fedora]: https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-linux#fedora
[in-archlinux]: https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-linux#arch-linux
[in-macos]: https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-macos
Update Docker link to PowerShell-Docker (#7351)
2018-07-25 15:28:37 +08:00
[in-docker]: https://github.com/PowerShell/PowerShell-Docker
Update docs.microsoft.com links (#12653) # PR Summary * remove explicit en-us from links * remove view parameter ## PR Context follow-up #7013 ## PR Checklist - [x] [PR has a meaningful title](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - Use the present tense and imperative mood when describing your changes - [x] [Summarized changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [x] [Make sure all `.h`, `.cpp`, `.cs`, `.ps1` and `.psm1` files have the correct copyright header](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [x] This PR is ready to merge and is not [Work in Progress](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---work-in-progress). - If the PR is work in progress, please add the prefix `WIP:` or `[ WIP ]` to the beginning of the title (the `WIP` bot will keep its status check at `Pending` while the prefix is present) and remove the prefix when the PR is ready. - **[Breaking changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#making-breaking-changes)** - [ ] None - **OR** - [ ] [Experimental feature(s) needed](https://github.com/MicrosoftDocs/PowerShell-Docs/blob/staging/reference/6/Microsoft.PowerShell.Core/About/about_Experimental_Features.md) - [ ] Experimental feature name(s): <!-- Experimental feature name(s) here --> - **User-facing changes** - [x] Not Applicable - **OR** - [ ] [Documentation needed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [ ] Issue filed: <!-- Number/link of that issue here --> - **Testing - New and feature** - [x] N/A or can only be tested interactively - **OR** - [ ] [Make sure you've added a new test if existing tests do not effectively test the code changed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#before-submitting) - **Tooling** - [x] I have considered the user experience from a tooling perspective and don't believe tooling will be impacted. - **OR** - [ ] I have considered the user experience from a tooling perspective and enumerated concerns in the summary. This may include: - Impact on [PowerShell Editor Services](https://github.com/PowerShell/PowerShellEditorServices) which is used in the [PowerShell extension](https://github.com/PowerShell/vscode-powershell) for VSCode (which runs in a different PS Host). - Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features. - Impact on [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer) (which provides linting & formatting in the editor extensions). - Impact on [EditorSyntax](https://github.com/PowerShell/EditorSyntax) (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
2020-05-15 11:29:43 +08:00
[in-kali]: https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-linux#kali
[in-windows-zip]: https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-windows#zip
[in-tar-linux]: https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-linux#binary-archives
[in-tar-macos]: https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-macos#binary-archives
[in-raspbian]: https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-linux#raspbian
[in-arm]: https://docs.microsoft.com/powershell/scripting/install/powershell-core-on-arm
Update DotNet Support links (#10145)
2019-07-16 01:30:24 +08:00
[corefx-win]:https://github.com/dotnet/core/blob/master/release-notes/3.0/3.0-supported-os.md#windows
[corefx-linux]:https://github.com/dotnet/core/blob/master/release-notes/3.0/3.0-supported-os.md#linux
[corefx-macos]:https://github.com/dotnet/core/blob/master/release-notes/3.0/3.0-supported-os.md#macos
Updated per feedback.
2016-06-25 02:18:01 +08:00
Update README.md
2016-08-06 05:10:42 +08:00
To install a specific version, visit [releases](https://github.com/PowerShell/PowerShell/releases).
update some wording
2016-07-14 06:59:08 +08:00
Fix Markdown lint issues (#3357) * Fix Markdown lint issues Make header styles consistent Make header names unique (make anchors usable) * Fix spelling of sign up * Add words used in readme to spelling dictionary.
2017-03-22 06:20:11 +08:00
## Community Dashboard
Update README.md to add the section of Community Dashboard (#3256)
2017-03-07 09:28:42 +08:00
[Dashboard](https://aka.ms/psgithubbi) with visualizations for community contributions and project status using PowerShell, Azure, and PowerBI.
Fix broken link for blogs in documents (#12471)
2020-04-24 14:01:47 +08:00
For more information on how and why we built this dashboard, check out this [blog post](https://devblogs.microsoft.com/powershell/powershell-open-source-community-dashboard/).
Update README.md to add the section of Community Dashboard (#3256)
2017-03-07 09:28:42 +08:00
Replace link to Slack with link to PowerShell Virtual User Group (#12786) <!-- Anything that looks like this is a comment and can't be seen after the Pull Request is created. --> # PR Summary <!-- Summarize your PR between here and the checklist. --> ## PR Context MicrosoftDocs/feedback/issues/2776 ## PR Checklist - [x] [PR has a meaningful title](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - Use the present tense and imperative mood when describing your changes - [x] [Summarized changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [x] [Make sure all `.h`, `.cpp`, `.cs`, `.ps1` and `.psm1` files have the correct copyright header](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [x] This PR is ready to merge and is not [Work in Progress](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---work-in-progress). - If the PR is work in progress, please add the prefix `WIP:` or `[ WIP ]` to the beginning of the title (the `WIP` bot will keep its status check at `Pending` while the prefix is present) and remove the prefix when the PR is ready. - **[Breaking changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#making-breaking-changes)** - [x] None - **OR** - [ ] [Experimental feature(s) needed](https://github.com/MicrosoftDocs/PowerShell-Docs/blob/staging/reference/6/Microsoft.PowerShell.Core/About/about_Experimental_Features.md) - [ ] Experimental feature name(s): <!-- Experimental feature name(s) here --> - **User-facing changes** - [x] Not Applicable - **OR** - [ ] [Documentation needed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [ ] Issue filed: <!-- Number/link of that issue here --> - **Testing - New and feature** - [x] N/A or can only be tested interactively - **OR** - [ ] [Make sure you've added a new test if existing tests do not effectively test the code changed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#before-submitting) - **Tooling** - [x] I have considered the user experience from a tooling perspective and don't believe tooling will be impacted. - **OR** - [ ] I have considered the user experience from a tooling perspective and enumerated concerns in the summary. This may include: - Impact on [PowerShell Editor Services](https://github.com/PowerShell/PowerShellEditorServices) which is used in the [PowerShell extension](https://github.com/PowerShell/vscode-powershell) for VSCode (which runs in a different PS Host). - Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features. - Impact on [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer) (which provides linting & formatting in the editor extensions). - Impact on [EditorSyntax](https://github.com/PowerShell/EditorSyntax) (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
2020-05-27 00:53:49 +08:00
## Chat
Add Gitter chat room badge
2016-08-18 23:44:07 +08:00
Want to chat with other members of the PowerShell community?
Added info on the community Powershell slack team (#2062) * Added info on the community Powershell slack team * Revised update about Slack team to readme.md * remove unneeded where * Adds a line break before the gitter badge * added missing full stops (periods)
2016-08-30 10:30:23 +08:00
We have a Gitter Room which you can join below.
Update readme gitter badge (#9920)
2019-06-21 04:07:42 +08:00
[![Join the chat](https://img.shields.io/static/v1.svg?label=chat&message=on%20gitter&color=informational&logo=gitter)](https://gitter.im/PowerShell/PowerShell?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Add Gitter chat room badge
2016-08-18 23:44:07 +08:00
Grammar correction of Readme.md and other docs (#13269)
2020-07-30 01:23:09 +08:00
There is also the community-driven PowerShell Virtual User Group, which you can join on:
Restore `markdownlint` tests (#12549) Co-authored-by: Travis Plunk <travis.plunk@microsoft.com>
2020-06-03 03:28:32 +08:00
Replace link to Slack with link to PowerShell Virtual User Group (#12786) <!-- Anything that looks like this is a comment and can't be seen after the Pull Request is created. --> # PR Summary <!-- Summarize your PR between here and the checklist. --> ## PR Context MicrosoftDocs/feedback/issues/2776 ## PR Checklist - [x] [PR has a meaningful title](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - Use the present tense and imperative mood when describing your changes - [x] [Summarized changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [x] [Make sure all `.h`, `.cpp`, `.cs`, `.ps1` and `.psm1` files have the correct copyright header](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [x] This PR is ready to merge and is not [Work in Progress](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---work-in-progress). - If the PR is work in progress, please add the prefix `WIP:` or `[ WIP ]` to the beginning of the title (the `WIP` bot will keep its status check at `Pending` while the prefix is present) and remove the prefix when the PR is ready. - **[Breaking changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#making-breaking-changes)** - [x] None - **OR** - [ ] [Experimental feature(s) needed](https://github.com/MicrosoftDocs/PowerShell-Docs/blob/staging/reference/6/Microsoft.PowerShell.Core/About/about_Experimental_Features.md) - [ ] Experimental feature name(s): <!-- Experimental feature name(s) here --> - **User-facing changes** - [x] Not Applicable - **OR** - [ ] [Documentation needed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [ ] Issue filed: <!-- Number/link of that issue here --> - **Testing - New and feature** - [x] N/A or can only be tested interactively - **OR** - [ ] [Make sure you've added a new test if existing tests do not effectively test the code changed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#before-submitting) - **Tooling** - [x] I have considered the user experience from a tooling perspective and don't believe tooling will be impacted. - **OR** - [ ] I have considered the user experience from a tooling perspective and enumerated concerns in the summary. This may include: - Impact on [PowerShell Editor Services](https://github.com/PowerShell/PowerShellEditorServices) which is used in the [PowerShell extension](https://github.com/PowerShell/vscode-powershell) for VSCode (which runs in a different PS Host). - Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features. - Impact on [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer) (which provides linting & formatting in the editor extensions). - Impact on [EditorSyntax](https://github.com/PowerShell/EditorSyntax) (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
2020-05-27 00:53:49 +08:00
* [Slack](https://aka.ms/psslack)
* [Discord](https://aka.ms/psdiscord)
Fix Markdown lint issues (#3357) * Fix Markdown lint issues Make header styles consistent Make header names unique (make anchors usable) * Fix spelling of sign up * Add words used in readme to spelling dictionary.
2017-03-22 06:20:11 +08:00
Update README.md (#3873) Added link to "awesome-powershell"
2017-06-08 07:25:32 +08:00
## Add-ons and libraries
Simple grammatical correction in `README.md` file (#7978)
2018-11-02 04:04:48 +08:00
[Awesome PowerShell](https://github.com/janikvonrotz/awesome-powershell) has a great curated list of add-ons and resources.
Update README.md (#3873) Added link to "awesome-powershell"
2017-06-08 07:25:32 +08:00
Fix Markdown lint issues (#3357) * Fix Markdown lint issues Make header styles consistent Make header names unique (make anchors usable) * Fix spelling of sign up * Add words used in readme to spelling dictionary.
2017-03-22 06:20:11 +08:00
## Building the Repository
Rewrite README
2016-07-28 05:47:03 +08:00
OS X -> macOS (#1934) Fix all documentation references of "OS X" to be "macOS", Apple's new brand. Code is left unchanged because we're matching .NET Core.
2016-08-27 03:08:50 +08:00
| Linux | Windows | macOS |
Rewrite README
2016-07-28 05:47:03 +08:00
|--------------------------|----------------------------|------------------------|
OS X -> macOS (#1934) Fix all documentation references of "OS X" to be "macOS", Apple's new brand. Code is left unchanged because we're matching .NET Core.
2016-08-27 03:08:50 +08:00
| [Instructions][bd-linux] | [Instructions][bd-windows] | [Instructions][bd-macOS] |
Rewrite README
2016-07-28 05:47:03 +08:00
Move build badges * Remove superfluous link to releases page * Remove superfluous link to docs/build * Add column back for install instructions * Add extra link to the FAQ
2016-07-29 03:45:31 +08:00
If you have any problems building, please consult the developer [FAQ][].
Add badge for nightly builds (#2455) Add the badge for nightly builds with a link to the build page.
2016-10-13 04:34:24 +08:00
### Build status of nightly builds
Fix some typos in the README (#8623)
2019-01-12 08:47:11 +08:00
| Azure CI (Windows) | Azure CI (Linux) | Azure CI (macOS) | Code Coverage Status | CodeFactor Grade |
update build badges (#7792)
2018-09-18 05:26:27 +08:00
|:-----------------------------------------|:-----------------------------------------------|:-----------------------------------------------|:-------------------------|:-------------------------|
Remove all reference to AppVeyor and Travis CI from docs (#8376)
2018-12-04 02:14:11 +08:00
| [![windows-nightly-image][]][windows-nightly-site] | [![linux-nightly-image][]][linux-nightly-site] | [![macOS-nightly-image][]][macos-nightly-site] | [![cc-image][]][cc-site] | [![cf-image][]][cf-site] |
Add badge for nightly builds (#2455) Add the badge for nightly builds with a link to the build page.
2016-10-13 04:34:24 +08:00
Change all links in README.md to absolute as it is being reused in other places outside of GitHub (#5354)
2017-11-07 02:29:49 +08:00
[bd-linux]: https://github.com/PowerShell/PowerShell/tree/master/docs/building/linux.md
[bd-windows]: https://github.com/PowerShell/PowerShell/tree/master/docs/building/windows-core.md
[bd-macOS]: https://github.com/PowerShell/PowerShell/tree/master/docs/building/macos.md
Add explicit dependency instructions to README
2016-01-22 04:25:48 +08:00
Change all links in README.md to absolute as it is being reused in other places outside of GitHub (#5354)
2017-11-07 02:29:49 +08:00
[FAQ]: https://github.com/PowerShell/PowerShell/tree/master/docs/FAQ.md
Move build badges * Remove superfluous link to releases page * Remove superfluous link to docs/build * Add column back for install instructions * Add extra link to the FAQ
2016-07-29 03:45:31 +08:00
Fix broken link in `README.md` (#12887)
2020-06-05 00:45:35 +08:00
[windows-nightly-site]: https://powershell.visualstudio.com/PowerShell/_build?definitionId=32
update build badges (#7792)
2018-09-18 05:26:27 +08:00
[linux-nightly-site]: https://powershell.visualstudio.com/PowerShell/_build?definitionId=23
[macos-nightly-site]: https://powershell.visualstudio.com/PowerShell/_build?definitionId=24
Remove all reference to AppVeyor and Travis CI from docs (#8376)
2018-12-04 02:14:11 +08:00
[windows-nightly-image]: https://powershell.visualstudio.com/PowerShell/_apis/build/status/PowerShell-CI-Windows-daily
update build badges (#7792)
2018-09-18 05:26:27 +08:00
[linux-nightly-image]: https://powershell.visualstudio.com/PowerShell/_apis/build/status/PowerShell-CI-linux-daily?branchName=master
[macOS-nightly-image]: https://powershell.visualstudio.com/PowerShell/_apis/build/status/PowerShell-CI-macos-daily?branchName=master
Updated Code Coverage badge and filtered out PSReadline module (#4121)
2017-07-08 00:29:23 +08:00
[cc-site]: https://codecov.io/gh/PowerShell/PowerShell
[cc-image]: https://codecov.io/gh/PowerShell/PowerShell/branch/master/graph/badge.svg
Disable some StyleCop rules (#6986) * Disable some StyleCop rules * Add CodeFactor status badge in README.md
2018-06-05 19:32:06 +08:00
[cf-site]: https://www.codefactor.io/repository/github/powershell/powershell
[cf-image]: https://www.codefactor.io/repository/github/powershell/powershell/badge
Move build badges * Remove superfluous link to releases page * Remove superfluous link to docs/build * Add column back for install instructions * Add extra link to the FAQ
2016-07-29 03:45:31 +08:00
Fix Markdown lint issues (#3357) * Fix Markdown lint issues Make header styles consistent Make header names unique (make anchors usable) * Fix spelling of sign up * Add words used in readme to spelling dictionary.
2017-03-22 06:20:11 +08:00
## Downloading the Source Code
Rewrite README
2016-07-28 05:47:03 +08:00
Remove build and doc references to Git submodules (#8177) As of #7892, the PowerShell repository no longer uses Git submodules. This is fantastic from a workflow standpoint, and so all the notes about how to deal with submodules (and all the build steps explicitly initializing and updating submodules) can be safely removed.
2018-11-06 02:39:29 +08:00
You can just clone the repository:
Rewrite README
2016-07-28 05:47:03 +08:00
Updated the Downloading Source code section to address the feedback from lzybkr.
2016-07-21 08:23:06 +08:00
```sh
Remove build and doc references to Git submodules (#8177) As of #7892, the PowerShell repository no longer uses Git submodules. This is fantastic from a workflow standpoint, and so all the notes about how to deal with submodules (and all the build steps explicitly initializing and updating submodules) can be safely removed.
2018-11-06 02:39:29 +08:00
git clone https://github.com/PowerShell/PowerShell.git
Updated the Downloading Source code section to address the feedback from lzybkr.
2016-07-21 08:23:06 +08:00
```
Rewrite README
2016-07-28 05:47:03 +08:00
Change all links in README.md to absolute as it is being reused in other places outside of GitHub (#5354)
2017-11-07 02:29:49 +08:00
See [working with the PowerShell repository](https://github.com/PowerShell/PowerShell/tree/master/docs/git) for more information.
Rewrite README
2016-07-28 05:47:03 +08:00
Fix Markdown lint issues (#3357) * Fix Markdown lint issues Make header styles consistent Make header names unique (make anchors usable) * Fix spelling of sign up * Add words used in readme to spelling dictionary.
2017-03-22 06:20:11 +08:00
## Developing and Contributing
Simplified over complicated table into single link. Removed redundant contributing text and replaced with link to contributing doc. Removed maitaner specific text and replaced with link to contributor specific section for the topic
2016-07-21 02:18:28 +08:00
Rewrite README
2016-07-28 05:47:03 +08:00
Please see the [Contribution Guide][] for how to develop and contribute.
OS X -> macOS (#1934) Fix all documentation references of "OS X" to be "macOS", Apple's new brand. Code is left unchanged because we're matching .NET Core.
2016-08-27 03:08:50 +08:00
If you are developing .NET Core C# applications targeting PowerShell Core, please [check out our FAQ][] to learn more about the PowerShell SDK NuGet package.
(WIP) Updated draft of readme for PM review.
2016-06-23 23:21:07 +08:00
README.md (#9045) Added punctuations wherever necessary.
2019-03-12 06:20:36 +08:00
Also, make sure to check out our [PowerShell-RFC repository](https://github.com/powershell/powershell-rfc) for request-for-comments (RFC) documents to submit and give comments on proposed and future designs.
Add PowerShell-RFC link to README (#2431) * Update README.md * Update README.md since we're being pedantic :)
2016-10-07 02:26:13 +08:00
Update README.md The last two commits to this file "broke" both "Developing and contributing"(link is missing) and "Support" (don't know what it didn't format correctly. This commit fixes both cases.
2019-01-18 22:49:21 +08:00
[Contribution Guide]: https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md
Change all links in README.md to absolute as it is being reused in other places outside of GitHub (#5354)
2017-11-07 02:29:49 +08:00
[check out our FAQ]: https://github.com/PowerShell/PowerShell/tree/master/docs/FAQ.md#where-do-i-get-the-powershell-core-sdk-package
Create Support File (#8618)
2019-01-18 04:25:07 +08:00
Update stable version to 6.1.3 (#8902)
2019-02-20 03:07:46 +08:00
## Support
Create Support File (#8618)
2019-01-18 04:25:07 +08:00
README.md (#9045) Added punctuations wherever necessary.
2019-03-12 06:20:36 +08:00
For support, please see the [Support Section][].
Update README.md The last two commits to this file "broke" both "Developing and contributing"(link is missing) and "Support" (don't know what it didn't format correctly. This commit fixes both cases.
2019-01-18 22:49:21 +08:00
Create Support File (#8618)
2019-01-18 04:25:07 +08:00
[Support Section]: https://github.com/PowerShell/PowerShell/tree/master/.github/SUPPORT.md
Add official Microsoft Open Source Code of Conduct
2016-06-25 01:47:46 +08:00
Fix Markdown lint issues (#3357) * Fix Markdown lint issues Make header styles consistent Make header names unique (make anchors usable) * Fix spelling of sign up * Add words used in readme to spelling dictionary.
2017-03-22 06:20:11 +08:00
## Legal and Licensing
update README with license info
2016-07-30 05:10:26 +08:00
PowerShell is licensed under the [MIT license][].
Change all links in README.md to absolute as it is being reused in other places outside of GitHub (#5354)
2017-11-07 02:29:49 +08:00
[MIT license]: https://github.com/PowerShell/PowerShell/tree/master/LICENSE.txt
update README with license info
2016-07-30 05:10:26 +08:00
Refer to Windows docker images license in main readme (#3469)
2017-04-01 03:34:01 +08:00
### Windows Docker Files and Images
Fix some typos in the README (#8623)
2019-01-12 08:47:11 +08:00
License: By requesting and using the Container OS Image for Windows containers, you acknowledge, understand, and consent to the Supplemental License Terms available on Docker Hub:
Refer to Windows docker images license in main readme (#3469)
2017-04-01 03:34:01 +08:00
Fix typo in README.md (#8642)
2019-01-15 15:29:47 +08:00
- [Windows Server Core](https://hub.docker.com/r/microsoft/windowsservercore/)
Refer to Windows docker images license in main readme (#3469)
2017-04-01 03:34:01 +08:00
- [Nano Server](https://hub.docker.com/r/microsoft/nanoserver/)
Add statement to README.md covering the current telemetry implementation (#3673) Add statement regarding the current telemetry implementation to address concerns from Privacy Review
2017-05-03 09:27:42 +08:00
### Telemetry
Update links that contain 'en-us' culture (#7013) Update links that contain 'en-us' culture to remove 'en-us' culture (if possible) and in some cases update to newer re-directed link to docs.microsoft.com
2018-06-08 13:49:03 +08:00
By default, PowerShell collects the OS description and the version of PowerShell (equivalent to `$PSVersionTable.OS` and `$PSVersionTable.GitCommitId`) using [Application Insights](https://azure.microsoft.com/services/application-insights/).
Remove support for file to opt-out of telemetry, only support env var (#6601) Since a PR added support to opt out of telemetry via an environment variable, we can remove the, always intended to be a temporary, solution of deleting a file to opt out of telemetry since the environment variable can be defined at the system level and exist before even installing PowerShell Core. Because the variable is defined as opt out, a value of true, yes, or 1 means no telemetry is sent.
2018-04-14 01:29:39 +08:00
To opt-out of sending telemetry, create an environment variable called `POWERSHELL_TELEMETRY_OPTOUT` set to a value of `1` before starting PowerShell from the installed location.
Update README.md (#10465) Fix typo.
2019-08-31 03:05:26 +08:00
The telemetry we collect falls under the [Microsoft Privacy Statement](https://privacy.microsoft.com/privacystatement/).
Add statement to README.md covering the current telemetry implementation (#3673) Add statement regarding the current telemetry implementation to address concerns from Privacy Review
2017-05-03 09:27:42 +08:00
Fix Markdown lint issues (#3357) * Fix Markdown lint issues Make header styles consistent Make header names unique (make anchors usable) * Fix spelling of sign up * Add words used in readme to spelling dictionary.
2017-03-22 06:20:11 +08:00
## Governance
Add reference to governance document on to readme
2016-08-13 04:27:04 +08:00
Grammar correction of Readme.md and other docs (#13269)
2020-07-30 01:23:09 +08:00
The governance policy for the PowerShell project is described [here][].
Add reference to governance document on to readme
2016-08-13 04:27:04 +08:00
[here]: https://github.com/PowerShell/PowerShell/blob/master/docs/community/governance.md
add CODE_OF_CONDUCT.md (#4109) * add CODE_OF_CONDUCT.md * updated spelling for CODE_OF_CONDUCT.md * Fixed markdown lint error * added link to CODE_OF_CONDUCT.md as expected by GitHub
2017-06-29 01:34:09 +08:00
## [Code of Conduct][conduct-md]
Add official Microsoft Open Source Code of Conduct
2016-06-25 01:47:46 +08:00
added "recursive cloning" back to readme per request #1197
2016-07-21 08:09:41 +08:00
This project has adopted the [Microsoft Open Source Code of Conduct][conduct-code].
Rewrite README
2016-07-28 05:47:03 +08:00
For more information see the [Code of Conduct FAQ][conduct-FAQ] or contact [opencode@microsoft.com][conduct-email] with any additional questions or comments.
Add official Microsoft Open Source Code of Conduct
2016-06-25 01:47:46 +08:00
Create Support File (#8618)
2019-01-18 04:25:07 +08:00
[conduct-code]: https://opensource.microsoft.com/codeofconduct/
[conduct-FAQ]: https://opensource.microsoft.com/codeofconduct/faq/
Rewrite README
2016-07-28 05:47:03 +08:00
[conduct-email]: mailto:opencode@microsoft.com
Fix some typos in the README (#8623)
2019-01-12 08:47:11 +08:00
[conduct-md]: https://github.com/PowerShell/PowerShell/tree/master/CODE_OF_CONDUCT.md
Reference in New Issue Copy Permalink