PowerShell/README.md

![PowerShell Logo](assets/Powershell_64.png) 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.

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

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) |

Get PowerShell
--------------

|                       | Linux | Windows .NET Core | Windows .NET Full | OS X | PSRP |
|-----------------------|-------|-------------------|-------------------|------|------|
| 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][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][git-basics] where you will find Git installation
instructions, cheat sheets and links to our favorite Git tutorials. 

Please follow the git workflow for [powershell repository][git-commit].

To begin development, you'll need to setup your development environment for [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 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 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] using
the appropriate issue tag.

[git-basics]: docs/git/basics.md
[git-commit]: docs/git/powershell-repository-101.md
[contribution]: .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


PowerShell Community
--------------------
`TODO` Missing community details

Legal and Licensing
-------------------

`TODO` Missing license details

`TODO` Missing link to contributor agreement

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.

[conduct-code]: http://opensource.microsoft.com/codeofconduct/
[conduct-FAQ]: http://opensource.microsoft.com/codeofconduct/faq/
[conduct-email]: mailto:opencode@microsoft.com
WIP initial draft of readme 2016-06-23 01:57:17 +02:00			`![PowerShell Logo](assets/Powershell_64.png) PowerShell`
			`========================`
Add a readme 2015-07-02 00:06:29 +02:00
(WIP) Updated draft of readme for PM review. 2016-06-23 17:21:07 +02:00			`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`
Updated per feedback. 2016-06-24 20:18:01 +02:00			`automate administrative tasks on both local and remote Windows, Linux and OS X systems.`
Add build instructions matrix to readme 2016-03-31 00:13:29 +02:00
Updated per feedback. 2016-06-24 20:18:01 +02:00			`New to PowerShell?`
			`------------------`
(WIP) Updated draft of readme for PM review. 2016-06-23 17:21:07 +02:00			`If you are new to PowerShell and would like to learn more, we recommend`
Updated per feedback. 2016-06-24 20:18:01 +02:00			`reviewing the [getting started documentation][getting-started].`

updated link in readme 2016-07-12 22:27:21 +02:00			`[getting-started]: docs/learning-powerShell/learning-powershell.md`
Add build instructions matrix to readme 2016-03-31 00:13:29 +02:00
Refactor readme header 2016-03-30 21:06:57 +02:00			`Build Status`
			`------------`
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-22 20:36:23 +01:00
Remove server2016 from the build status matrix [skip ci] 2016-04-06 20:32:10 +02:00			\| Platform \| `master` \|
			`\|--------------\|----------\|`
			`\| Ubuntu 14.04 \| [![Build Status](https://travis-ci.com/PowerShell/PowerShell.svg?token=31YifM4jfyVpBmEGitCm&branch=master)](https://travis-ci.com/PowerShell/PowerShell) \|`
Update documentation for OS X testing Copy the Travis CI badge for 10.11. It is the same badge, but it will fail if the build fails. I don't see a way to have separate badges, but this highlights that the platform is being tested. 2016-04-14 20:25:09 +02:00			`\| OS X 10.11 \| [![Build Status](https://travis-ci.com/PowerShell/PowerShell.svg?token=31YifM4jfyVpBmEGitCm&branch=master)](https://travis-ci.com/PowerShell/PowerShell) \|`
Update appveyor badge link [skip ci] 2016-05-22 09:16:41 +02:00			`\| Windows \| [![Build status](https://ci.appveyor.com/api/projects/status/jtefab3hpngtyesp/branch/master?svg=true)](https://ci.appveyor.com/project/PowerShell/powershell/branch/master) \|`
Refactor readme header 2016-03-30 21:06:57 +02:00
Add build instructions matrix to readme 2016-03-31 00:13:29 +02:00			`Get PowerShell`
			`--------------`

Move PSRP notes 2016-03-31 00:57:52 +02:00			`\| \| Linux \| Windows .NET Core \| Windows .NET Full \| OS X \| PSRP \|`
			`\|-----------------------\|-------\|-------------------\|-------------------\|------\|------\|`
Updated per feedback. 2016-06-24 20:18:01 +02:00			`\| 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 \|`
Add a readme 2015-07-02 00:06:29 +02:00
(WIP) Updated draft of readme for PM review. 2016-06-23 17:21:07 +02:00			`If installing PowerShell from a package, please refer to the installation`
Updated per feedback. 2016-06-24 20:18:01 +02:00			`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`
Add a readme 2015-07-02 00:06:29 +02:00
WIP initial draft of readme 2016-06-23 01:57:17 +02:00			`Developing and Contributing`
			`--------------------------`
Updated per feedback. 2016-06-24 20:18:01 +02:00			`If you are new to Git, we recommend you start by reviewing our`
			`[Git basics document][git-basics] where you will find Git installation`
update some wording 2016-07-14 00:59:08 +02:00			`instructions, cheat sheets and links to our favorite Git tutorials.`

update some wording 2016-07-14 01:44:40 +02:00			`Please follow the git workflow for [powershell repository][git-commit].`
Add explicit dependency instructions to README 2016-01-21 21:25:48 +01:00
first pass of contributor docs Rework of contributor docs to reflect actual flow for both internal and external developers using the PowerShell/PowerShell repo for the first time. Includes updates to issue/PR guidelines, repo 101, and CONTRIBUTING.md. 2016-07-11 18:42:22 +02:00			`To begin development, you'll need to setup your development environment for [Linux][build-linux], [Windows Core][build-wc], [Windows Full][build-wf] or`
Updated per feedback. 2016-06-24 20:18:01 +02:00			`[OS X][build-osx] and are encouraged to review the`
			`[contribution guidelines][contribution] for specific workflow, test`
(WIP) Updated draft of readme for PM review. 2016-06-23 17:21:07 +02:00			`requirements and coding guidelines.`
Update README.md Add more info about git on windows [no ci] 2016-03-09 23:24:15 +01:00
first pass of contributor docs Rework of contributor docs to reflect actual flow for both internal and external developers using the PowerShell/PowerShell repo for the first time. Includes updates to issue/PR guidelines, repo 101, and CONTRIBUTING.md. 2016-07-11 18:42:22 +02:00			`If you encounter issues in your development, please consult the [known issues][known-issues]`
Updated per feedback. 2016-06-24 20:18:01 +02:00			`and [FAQ][faq] documents to see if the issue you are running into is`
(WIP) Updated draft of readme for PM review. 2016-06-23 17:21:07 +02:00			`captured and if a workaround exists.`
Update README.md Add more info about git on windows [no ci] 2016-03-09 23:24:15 +01:00
first pass of contributor docs Rework of contributor docs to reflect actual flow for both internal and external developers using the PowerShell/PowerShell repo for the first time. Includes updates to issue/PR guidelines, repo 101, and CONTRIBUTING.md. 2016-07-11 18:42:22 +02:00			`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] using`
Updated per feedback. 2016-06-24 20:18:01 +02:00			`the appropriate issue tag.`

			`[git-basics]: docs/git/basics.md`
first pass of contributor docs Rework of contributor docs to reflect actual flow for both internal and external developers using the PowerShell/PowerShell repo for the first time. Includes updates to issue/PR guidelines, repo 101, and CONTRIBUTING.md. 2016-07-11 18:42:22 +02:00			`[git-commit]: docs/git/powershell-repository-101.md`
fixed a broken link in readme 2016-06-25 01:49:24 +02:00			`[contribution]: .github/CONTRIBUTING.md`
Updated per feedback. 2016-06-24 20:18:01 +02:00			`[known-issues]: docs/KNOWNISSUES.md`
			`[faq]: docs/FAQ.md`
first pass of contributor docs Rework of contributor docs to reflect actual flow for both internal and external developers using the PowerShell/PowerShell repo for the first time. Includes updates to issue/PR guidelines, repo 101, and CONTRIBUTING.md. 2016-07-11 18:42:22 +02:00			`[github-issues]:https://github.com/PowerShell/PowerShell/issues`
Updated per feedback. 2016-06-24 20:18:01 +02:00			`[new-issue]:https://github.com/PowerShell/PowerShell/issues/new`

Add explicit dependency instructions to README 2016-01-21 21:25:48 +01:00
WIP initial draft of readme 2016-06-23 01:57:17 +02:00			`PowerShell Community`
			`--------------------`
			`TODO` Missing community details
Update Git setup documentation Now that everyone needs all the submodules. Much simpler. 2016-04-13 01:16:17 +02:00
WIP initial draft of readme 2016-06-23 01:57:17 +02:00			`Legal and Licensing`
			`-------------------`
(WIP) Updated draft of readme for PM review. 2016-06-23 17:21:07 +02:00
WIP initial draft of readme 2016-06-23 01:57:17 +02:00			`TODO` Missing license details
(WIP) Updated draft of readme for PM review. 2016-06-23 17:21:07 +02:00
			`TODO` Missing link to contributor agreement
Add official Microsoft Open Source Code of Conduct 2016-06-24 19:47:46 +02:00
			`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.`

			`[conduct-code]: http://opensource.microsoft.com/codeofconduct/`
			`[conduct-FAQ]: http://opensource.microsoft.com/codeofconduct/faq/`
			`[conduct-email]: mailto:opencode@microsoft.com`