mirror of
https://github.com/PowerShell/PowerShell.git
synced 2024-11-23 09:43: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.
This commit is contained in:
Travis Plunk
GitHub
parent
c31d584737
commit
70f6e176de
@ -484,6 +484,9 @@ ShouldShouldIt
|
||||
- README.md
|
||||
opencode
|
||||
microsoft.com
|
||||
Gitter
|
||||
msi
|
||||
pkg
|
||||
- src/libpsl-native/README.md
|
||||
libpsl-native
|
||||
C#'s
|
||||
|
||||
38
README.md
38
README.md
@ -1,5 +1,4 @@
|
||||
![logo][] PowerShell
|
||||
====================
|
||||
# ![logo][] PowerShell
|
||||
|
||||
Welcome to the PowerShell GitHub Community!
|
||||
PowerShell 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.
|
||||
@ -8,15 +7,13 @@ It includes a command-line shell, an associated scripting language and a framewo
|
||||
|
||||
[logo]: assets/Powershell_64.png
|
||||
|
||||
New to PowerShell?
|
||||
------------------
|
||||
## New to PowerShell?
|
||||
|
||||
If you are new to PowerShell and would like to learn more, we recommend reviewing the [getting started][] documentation.
|
||||
|
||||
[getting started]: docs/learning-powershell
|
||||
|
||||
Get PowerShell
|
||||
--------------
|
||||
## Get PowerShell
|
||||
|
||||
You can download and install a PowerShell package for any of the following platforms.
|
||||
|
||||
@ -56,15 +53,13 @@ You can download and install a PowerShell package for any of the following platf
|
||||
|
||||
To install a specific version, visit [releases](https://github.com/PowerShell/PowerShell/releases).
|
||||
|
||||
Community Dashboard
|
||||
-------------------
|
||||
## Community Dashboard
|
||||
|
||||
[Dashboard](https://aka.ms/psgithubbi) with visualizations for community contributions and project status using PowerShell, Azure, and PowerBI.
|
||||
|
||||
For more information on how and why we built this dashboard, check out this [blog post](https://blogs.msdn.microsoft.com/powershell/2017/01/31/powershell-open-source-community-dashboard/).
|
||||
|
||||
Chat Room
|
||||
---------
|
||||
## Chat Room
|
||||
|
||||
Want to chat with other members of the PowerShell community?
|
||||
|
||||
@ -72,11 +67,11 @@ We have a Gitter Room which you can join below.
|
||||
|
||||
[](https://gitter.im/PowerShell/PowerShell?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
|
||||
There is also the community driven PowerShell Slack Team which you can sign up for at [Slack Signup].
|
||||
There is also the community driven PowerShell Slack Team which you can sign up for at [Slack Sign up].
|
||||
|
||||
[Slack Signup]: http://slack.poshcode.org
|
||||
Building the Repository
|
||||
-----------------------
|
||||
[Slack Sign up]: http://slack.poshcode.org
|
||||
|
||||
## Building the Repository
|
||||
|
||||
| Linux | Windows | macOS |
|
||||
|--------------------------|----------------------------|------------------------|
|
||||
@ -112,8 +107,7 @@ If you have any problems building, please consult the developer [FAQ][].
|
||||
[cc-site]: https://coveralls.io/github/PowerShell/PowerShell?branch=master
|
||||
[cc-image]: https://coveralls.io/repos/github/PowerShell/PowerShell/badge.svg?branch=master
|
||||
|
||||
Downloading the Source Code
|
||||
---------------------------
|
||||
## Downloading the Source Code
|
||||
|
||||
The PowerShell repository has a number of other repositories embedded as submodules.
|
||||
|
||||
@ -131,8 +125,7 @@ git submodule update --init
|
||||
|
||||
See [working with the PowerShell repository](docs/git) for more information.
|
||||
|
||||
Developing and Contributing
|
||||
--------------------------
|
||||
## Developing and Contributing
|
||||
|
||||
Please see the [Contribution Guide][] for how to develop and contribute.
|
||||
|
||||
@ -148,22 +141,19 @@ Also make sure to check out our [PowerShell-RFC repository](https://github.com/p
|
||||
[GitHub issues]: https://github.com/PowerShell/PowerShell/issues
|
||||
[new issue]:https://github.com/PowerShell/PowerShell/issues/new
|
||||
|
||||
Legal and Licensing
|
||||
-------------------
|
||||
## Legal and Licensing
|
||||
|
||||
PowerShell is licensed under the [MIT license][].
|
||||
|
||||
[MIT license]: LICENSE.txt
|
||||
|
||||
Governance
|
||||
-------------------
|
||||
## Governance
|
||||
|
||||
Governance policy for PowerShell project is described [here][].
|
||||
|
||||
[here]: https://github.com/PowerShell/PowerShell/blob/master/docs/community/governance.md
|
||||
|
||||
Code of Conduct
|
||||
---------------
|
||||
## Code of Conduct
|
||||
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct][conduct-code].
|
||||
For more information see the [Code of Conduct FAQ][conduct-FAQ] or contact [opencode@microsoft.com][conduct-email] with any additional questions or comments.
|
||||
|
||||
@ -1,5 +1,4 @@
|
||||
Package installation instructions
|
||||
=================================
|
||||
# Package installation instructions
|
||||
|
||||
Supports [Ubuntu 14.04][u14], [Ubuntu 16.04][u16],
|
||||
[CentOS 7][cos], [Arch Linux][arch], [many Linux distributions (AppImage)][lai], and [macOS 10.11][mac].
|
||||
@ -24,8 +23,7 @@ Once the package is installed, run `powershell` from a terminal.
|
||||
[mac]: #macos-1011
|
||||
[download]: https://github.com/PowerShell/PowerShell/blob/v6.0.0-alpha.17/tools/download.sh
|
||||
|
||||
Ubuntu 14.04
|
||||
============
|
||||
## Ubuntu 14.04
|
||||
|
||||
Using [Ubuntu 14.04][], download the Debian package
|
||||
`powershell_6.0.0-alpha.17-1ubuntu1.14.04.1_amd64.deb`
|
||||
@ -42,7 +40,7 @@ sudo apt-get install -f
|
||||
> the next command, `apt-get install -f` resolves these
|
||||
> and then finishes configuring the PowerShell package.
|
||||
|
||||
**Uninstallation**
|
||||
### Uninstallation - Ubuntu 14.04
|
||||
|
||||
```sh
|
||||
sudo apt-get remove powershell
|
||||
@ -50,8 +48,7 @@ sudo apt-get remove powershell
|
||||
|
||||
[Ubuntu 14.04]: http://releases.ubuntu.com/14.04/
|
||||
|
||||
Ubuntu 16.04
|
||||
============
|
||||
## Ubuntu 16.04
|
||||
|
||||
Using [Ubuntu 16.04][], download the Debian package
|
||||
`powershell_6.0.0-alpha.17-1ubuntu1.16.04.1_amd64.deb`
|
||||
@ -68,7 +65,7 @@ sudo apt-get install -f
|
||||
> the next command, `apt-get install -f` resolves these
|
||||
> and then finishes configuring the PowerShell package.
|
||||
|
||||
**Uninstallation**
|
||||
### Uninstallation - Ubuntu 16.04
|
||||
|
||||
```sh
|
||||
sudo apt-get remove powershell
|
||||
@ -78,8 +75,7 @@ sudo apt-get remove powershell
|
||||
|
||||
This works for Debian Stretch (now testing) as well.
|
||||
|
||||
CentOS 7
|
||||
========
|
||||
## CentOS 7
|
||||
|
||||
Using [CentOS 7][], download the RPM package
|
||||
`powershell-6.0.0_alpha.17-1.el7.centos.x86_64.rpm`
|
||||
@ -99,7 +95,7 @@ sudo yum install https://github.com/PowerShell/PowerShell/releases/download/v6.0
|
||||
|
||||
> This package works on Oracle Linux 7. It should work on Red Hat Enterprise Linux 7 too.
|
||||
|
||||
**Uninstallation**
|
||||
### Uninstallation
|
||||
|
||||
```sh
|
||||
sudo yum remove powershell
|
||||
@ -107,8 +103,7 @@ sudo yum remove powershell
|
||||
|
||||
[CentOS 7]: https://www.centos.org/download/
|
||||
|
||||
Arch Linux
|
||||
==========
|
||||
## Arch Linux
|
||||
|
||||
PowerShell is available from the [Arch Linux][] User Repository (AUR) as a [release][arch-release] or the [latest development build][arch-git].
|
||||
|
||||
@ -120,8 +115,7 @@ For more information on installing packages from the AUR, see the [Arch Linux wi
|
||||
[arch-release]: https://aur.archlinux.org/packages/powershell/
|
||||
[arch-git]: https://aur.archlinux.org/packages/powershell-git/
|
||||
|
||||
Linux AppImage
|
||||
==============
|
||||
## Linux AppImage
|
||||
|
||||
Using a recent Linux distribution,
|
||||
download the AppImage `PowerShell-x86_64.AppImage`
|
||||
@ -129,7 +123,7 @@ from the [releases][] page onto the Linux machine.
|
||||
|
||||
Then execute the following in the terminal:
|
||||
|
||||
```
|
||||
```bash
|
||||
chmod a+x PowerShell-x86_64.AppImage
|
||||
./PowerShell-x86_64.AppImage
|
||||
```
|
||||
@ -142,8 +136,7 @@ and is a single binary.
|
||||
|
||||
[appimage]: http://appimage.org/
|
||||
|
||||
macOS 10.11
|
||||
===========
|
||||
## macOS 10.11
|
||||
|
||||
Using macOS 10.11, download the PKG package
|
||||
`powershell-6.0.0-alpha.17.pkg`
|
||||
@ -156,7 +149,7 @@ or install it from the terminal:
|
||||
sudo installer -pkg powershell-6.0.0-alpha.17.pkg -target /
|
||||
```
|
||||
|
||||
**Uninstallation**
|
||||
### Uninstallation - macOS 10.11
|
||||
|
||||
PowerShell on MacOS must be removed manually.
|
||||
|
||||
@ -172,12 +165,11 @@ and remove the desired the paths with `sudo rm`.
|
||||
|
||||
[paths]:#paths
|
||||
|
||||
OpenSSL
|
||||
-------
|
||||
## OpenSSL
|
||||
|
||||
Also install [Homebrew's OpenSSL][openssl]:
|
||||
|
||||
```
|
||||
```bash
|
||||
brew install openssl
|
||||
brew install curl --with-openssl
|
||||
```
|
||||
@ -203,7 +195,7 @@ they will fail to work unless the libraries are manually placed there (security
|
||||
or their libraries are patched (which we do).
|
||||
To patch .NET Core's cryptography libraries, we use `install_name_tool`:
|
||||
|
||||
```
|
||||
```bash
|
||||
find ~/.nuget -name System.Security.Cryptography.Native.dylib | xargs sudo install_name_tool -add_rpath /usr/local/opt/openssl/lib
|
||||
find ~/.nuget -name System.Net.Http.Native.dylib | xargs sudo install_name_tool -change /usr/lib/libcurl.4.dylib /usr/local/opt/curl/lib/libcurl.4.dylib
|
||||
```
|
||||
@ -218,8 +210,7 @@ You *can* run this command manually if you're having trouble with .NET Core's cr
|
||||
[brew]: http://brew.sh/
|
||||
[homebrew-patch]: https://github.com/Homebrew/brew/pull/597
|
||||
|
||||
Paths
|
||||
=====
|
||||
## Paths
|
||||
|
||||
* `$PSHOME` is `/opt/microsoft/powershell/6.0.0-alpha.17/`
|
||||
* User profiles will be read from `~/.config/powershell/profile.ps1`
|
||||
|
||||
Loading…
Reference in New Issue
Block a user