From 886dea5cb5caeb2b001ca19203deea1242ed3d5c Mon Sep 17 00:00:00 2001 From: Andrew Schwartzmeyer Date: Wed, 27 Jul 2016 14:47:03 -0700 Subject: [PATCH] Rewrite README --- README.md | 129 +++++++++++++++++++++++++++--------------------------- 1 file changed, 65 insertions(+), 64 deletions(-) diff --git a/README.md b/README.md index 89174fd4d..cb1eb463b 100644 --- a/README.md +++ b/README.md @@ -1,102 +1,103 @@ -![PowerShell Logo](assets/Powershell_64.png) PowerShell -======================== +![logo][] PowerShell +==================== -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 OS X systems. +PowerShell is a task automation and configuration management platform. +It consists of a cross-platform command-line shell and associated scripting language. + +[logo]: assets/Powershell_64.png New to PowerShell? ------------------ -If you are new to PowerShell and would like to learn more, we recommend -reviewing the [getting started documentation][getting-started]. -[getting-started]: docs/learning-powerShell/learning-powershell.md +If you are new to PowerShell and would like to learn more, we recommend reviewing the [getting started][] documentation. -Build Status ------------- - -| Platform | `master` | -|--------------|----------| -| Ubuntu 14.04 | [![Build Status](https://travis-ci.com/PowerShell/PowerShell.svg?token=31YifM4jfyVpBmEGitCm&branch=master)](https://travis-ci.com/PowerShell/PowerShell) | -| OS X 10.11 | [![Build Status](https://travis-ci.com/PowerShell/PowerShell.svg?token=31YifM4jfyVpBmEGitCm&branch=master)](https://travis-ci.com/PowerShell/PowerShell) | -| Windows | [![Build status](https://ci.appveyor.com/api/projects/status/jtefab3hpngtyesp/branch/master?svg=true)](https://ci.appveyor.com/project/PowerShell/powershell/branch/master) | +[getting started]: docs/learning-powershell Get PowerShell -------------- -1. Download the package for your platform at [PowerShell Releases][releases]. -1. Install the package. - * [Linux or OS X][inst-linux]. - * [Windows][inst-win]. +You can download and install a PowerShell package for any of the following platforms. +Our packages are hosted on the GitHub [releases][] page. -Building PowerShell -------------------- +| **Platform** | [Releases][] | Build status | +|--------------|---------------------------------------------------|--------------------------| +| Windows | [.msi][rl-windows] [(how to install)][in-windows] | [![av-image][]][av-site] | +| Ubuntu 14.04 | [.deb][rl-ubuntu] [(how to install)][in-ubuntu] | [![tv-image][]][tv-site] | +| CentOS 7 | [.rpm][rl-centos] [(how to install)][in-centos] | *N/A* | +| OS X 10.11 | [.pkg][rl-osx] [(how to install)][in-osx] | [![tv-image][]][tv-site] | -| Linux | Windows | OS X | -|-------|----------|------| -| [Instructions][build-linux] | [Instructions][build-wc] | [Instructions][build-osx] | +[releases]: https://github.com/PowerShell/PowerShell/releases +[rl-windows]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.7/PowerShell_6.0.0.7.msi +[rl-ubuntu]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.7/powershell_6.0.0-alpha.7-1_amd64.deb +[rl-centos]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.7/powershell-6.0.0_alpha.7-1.x86_64.rpm +[rl-osx]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.7/powershell-6.0.0-alpha.7.pkg + +[installation]: docs/installation +[in-windows]: docs/installation/windows.md#msi +[in-ubuntu]: docs/installation/linux.md#ubuntu-1404 +[in-centos]: docs/installation/linux.md#centos-7 +[in-osx]: docs/installation/linux.md#os-x-1011 + +[tv-image]: https://travis-ci.com/PowerShell/PowerShell.svg?token=31YifM4jfyVpBmEGitCm&branch=master +[tv-site]: https://travis-ci.com/PowerShell/PowerShell/branches +[av-image]: https://ci.appveyor.com/api/projects/status/jtefab3hpngtyesp/branch/master?svg=true +[av-site]: https://ci.appveyor.com/project/PowerShell/powershell/branch/master + +Building the Repository +----------------------- + +Please refer to the platform-specific [build][] documentation. + +| Linux | Windows | OS X | +|--------------------------|----------------------------|------------------------| +| [Instructions][bd-linux] | [Instructions][bd-windows] | [Instructions][bd-osx] | + +[build]: docs/building +[bd-linux]: docs/building/linux.md +[bd-windows]: docs/building/windows-core.md +[bd-osx]: docs/building/osx.md Downloading the Source Code ----------------------- +--------------------------- + The PowerShell repository has a number of other repositories embedded as submodules. -To make things easy, we can just clone recursively. + +To make things easy, we can just clone recursively: ```sh git clone --recursive https://github.com/PowerShell/PowerShell.git ``` If you already cloned but forgot to use `--recursive`, you can update submodules manually: + ```sh -git submodule init -git submodule update +git submodule update --init ``` + See [working with the PowerShell repository][powershell-repo-101] for more information. +[powershell-repo-101]: docs/git/powershell-repository-101.md + Developing and Contributing -------------------------- -Please see the [Contribution Guide][contribution] for how to develop and contribute. +Please see the [Contribution Guide][] for how to develop and contribute. -If you encounter issues in your development, 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 you have any problems, please consult the [known issues][], developer [FAQ][], and [GitHub issues][]. +If you do not see your problem captured, please file a [new issue][] and follow the provided template. -If you encounter issues with PowerShell itself, first search for it in our [issues][github-issues]. -If you do not see your issue captured, please file a [new issue][new-issue]. For more details see [Contributing to issues][contribution-issues]. - -PowerShell Community --------------------- -`TODO` Missing community details - -Legal and Licensing -------------------- - -`TODO` Missing license details - -`TODO` Missing link to contributor agreement +[Contribution Guide]: .github/CONTRIBUTING.md +[known issues]: docs/KNOWNISSUES.md +[FAQ]: docs/FAQ.md +[GitHub issues]: https://github.com/PowerShell/PowerShell/issues +[new issue]:https://github.com/PowerShell/PowerShell/issues/new 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. +For more information see the [Code of Conduct FAQ][conduct-FAQ] or contact [opencode@microsoft.com][conduct-email] with any additional questions or comments. -[build-linux]: docs/building/linux.md -[build-osx]: docs/building/osx.md -[build-wc]: docs/building/windows-core.md [conduct-code]: http://opensource.microsoft.com/codeofconduct/ -[conduct-email]: mailto:opencode@microsoft.com [conduct-FAQ]: http://opensource.microsoft.com/codeofconduct/faq/ -[contribution]: .github/CONTRIBUTING.md -[contribution-issues]: .github/CONTRIBUTING.md#contributing-to-issues -[faq]: docs/FAQ.md -[github-issues]:https://github.com/PowerShell/PowerShell/issues -[inst-linux]: docs/installation/linux.md -[inst-win]: docs/installation/windows.md -[known-issues]: docs/KNOWNISSUES.md -[new-issue]:https://github.com/PowerShell/PowerShell/issues/new -[releases]: https://github.com/PowerShell/PowerShell/releases -[powershell-repo-101]: docs/git/powershell-repository-101.md +[conduct-email]: mailto:opencode@microsoft.com