From abc83b0e51e9b6011c23945f43d13beee758dfdc Mon Sep 17 00:00:00 2001 From: Don Gill Date: Fri, 24 Jun 2016 11:18:01 -0700 Subject: [PATCH] Updated per feedback. --- README.md | 56 +++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 38 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index ab03375ac8..aef138f4d9 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,14 @@ PowerShell is a task automation and configuration management platform, consisting of a command-line shell and associated scripting language built using the [.NET Command Line Interface](https://github.com/dotnet/cli). PowerShell provides full access to COM and WMI, enabling administrators to -automate administrative tasks on both local and remote Windows, Linux and OSX systems. +automate administrative tasks on both local and remote Windows, Linux and OS X systems. -## 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](https://msdn.microsoft.com/en-us/powershell/scripting/getting-started/getting-started-with-windows-powershell). +reviewing the [getting started documentation][getting-started]. + +[getting-started]: https://msdn.microsoft.com/en-us/powershell/scripting/getting-started/getting-started-with-windows-powershell Build Status ------------ @@ -25,32 +28,49 @@ Get PowerShell | | Linux | Windows .NET Core | Windows .NET Full | OS X | PSRP | |-----------------------|-------|-------------------|-------------------|------|------| -| Build from **Source** | [Instructions](docs/building/linux.md) | [Instructions](docs/building/windows-core.md) | [Instructions](docs/building/windows-full.md) | [Instructions](docs/building/osx.md) | [Instructions](https://github.com/PowerShell/psl-omi-provider) | -| Get **Binaries** | [Releases](https://github.com/PowerShell/PowerShell/releases) | [Releases](https://github.com/PowerShell/PowerShell/releases) | [Artifacts](https://ci.appveyor.com/project/PowerShell/powershell/build/artifacts) | [Releases](https://github.com/PowerShell/PowerShell/releases) | TBD | +| Build from **Source** | [Instructions][build-linux] | [Instructions][build-wc] | [Instructions][build-wf] | [Instructions][build-osx] | [Instructions][pls-omi-provider] | +| Get **Binaries** | [Releases][releases] | [Releases][releases] | [Artifacts][artifacts] | [Releases][releases] | TBD | If installing PowerShell from a package, please refer to the installation -documents for [Linux](docs/installation/linux.md) and [Windows](docs/installation/windows.md). +documents for [Linux][inst-linux] and [Windows][inst-win]. + +[releases]: https://github.com/PowerShell/PowerShell/releases +[artifacts]: https://ci.appveyor.com/project/PowerShell/powershell/build/artifacts +[build-wc]: docs/building/windows-core.md +[build-wf]: docs/building/windows-full.md +[build-osx]: docs/building/osx.md +[build-linux]: docs/building/linux.md +[pls-omi-provider]: https://github.com/PowerShell/psl-omi-provider +[inst-linux]: docs/installation/linux.md +[inst-win]: docs/installation/windows.md Developing and Contributing -------------------------- -If you are new to GIT, we recommend you start by reviewing our -[GIT basics document](docs/git/basics.md) where you will find GIT installation -instructions, cheat sheets and links to our favorite GIT tutorials. We also -recommend, reviewing an example of a [basic GIT commit walkthrough](docs/git/committing.md). +If you are new to Git, we recommend you start by reviewing our +[Git basics document][git-basics] where you will find Git installation +instructions, cheat sheets and links to our favorite Git tutorials. We also +recommend, reviewing an example of a [basic Git commit walkthrough][git-commit]. To begin development, you'll need to setup your development environment for -either [Linux](docs/building/linux.md), [Windows](docs/building/windows.md) or -[OSX](docs/building/osx.md) and are encouraged to review the -[contribution guidelines](.github/CONTRIBUTING.md) for specific workflow, test +either [Linux][build-linux], [Windows Core][build-wc], [Windows Full][build-wf] or +[OS X][build-osx] and are encouraged to review the +[contribution guidelines][contribution] for specific workflow, test requirements and coding guidelines. -If you encounter issues, please consult the [known issues](docs/KNOWNISSUES.md) -and [FAQ](docs/FAQ.md) documents to see if the issue you are running into is +If you encounter issues, please consult the [known issues][known-issues] +and [FAQ][faq] documents to see if the issue you are running into is captured and if a workaround exists. -If do not see your issue captured, please file a -[new issue](https://github.com/PowerShell/PowerShell/issues/new) using the -appropriate issue tag. +If do not see your issue captured, please file a [new issue][new-issue] using +the appropriate issue tag. + +[git-basics]: docs/git/basics.md +[git-commit]: docs/git/committing.md +[contribution]: .github/CONTRIBUTING.md) +[known-issues]: docs/KNOWNISSUES.md +[faq]: docs/FAQ.md +[new-issue]:https://github.com/PowerShell/PowerShell/issues/new + PowerShell Community --------------------