2016-06-22 16:57:17 -07:00
 PowerShell
========================
2015-07-01 15:06:29 -07:00
2016-06-23 08:21:07 -07:00
PowerShell is a task automation and configuration management platform,
consisting of a command-line shell and associated scripting language built
2016-07-19 02:16:00 +02:00
using the [.NET Command-Line Interface ](https://github.com/dotnet/cli ).
2016-06-23 08:21:07 -07:00
PowerShell provides full access to COM and WMI, enabling administrators to
2016-07-19 02:16:00 +02:00
automate administrative tasks on both local and remote Windows, Linux, and OS X systems.
2016-03-30 15:13:29 -07:00
2016-06-24 11:18:01 -07:00
New to PowerShell?
------------------
2016-06-23 08:21:07 -07:00
If you are new to PowerShell and would like to learn more, we recommend
2016-06-24 11:18:01 -07:00
reviewing the [getting started documentation][getting-started].
2016-07-12 13:27:21 -07:00
[getting-started]: docs/learning-powerShell/learning-powershell.md
2016-03-30 15:13:29 -07:00
2016-03-30 12:06:57 -07:00
Build Status
------------
2016-01-22 11:36:23 -08:00
2016-04-06 11:32:10 -07:00
| Platform | `master` |
|--------------|----------|
| Ubuntu 14.04 | [](https://travis-ci.com/PowerShell/PowerShell) |
2016-04-14 11:25:09 -07:00
| OS X 10.11 | [](https://travis-ci.com/PowerShell/PowerShell) |
2016-05-22 00:16:41 -07:00
| Windows | [](https://ci.appveyor.com/project/PowerShell/powershell/branch/master) |
2016-03-30 12:06:57 -07:00
2016-03-30 15:13:29 -07:00
Get PowerShell
--------------
2016-07-20 11:36:06 -07:00
1. Download the package for your platform at [PowerShell Releases][releases].
1. Install the package.
* Package installation documents are available for [Linux][inst-linux] and [Windows][inst-win].
2016-06-24 11:18:01 -07:00
2016-07-19 15:18:10 -07:00
Building PowerShell
-------------------
| | Linux | Windows | OS X |
|-----------------------|-------|-------------------|------|
| Build from **Source** | [Instructions][build-linux] | [Instructions][build-wc] | [Instructions][build-osx] |
2016-06-22 16:57:17 -07:00
Developing and Contributing
--------------------------
2016-07-20 11:18:28 -07:00
Please see the [Contribution Guide][contribution] for how to develop and contribute.
2016-01-22 11:36:23 -08:00
2016-07-11 09:42:22 -07:00
If you encounter issues in your development, please consult the [known issues][known-issues]
2016-06-24 11:18:01 -07:00
and [FAQ][faq] documents to see if the issue you are running into is
2016-06-23 08:21:07 -07:00
captured and if a workaround exists.
2016-03-30 15:13:29 -07:00
2016-07-19 02:16:00 +02:00
If you encounter issues with PowerShell itself, first search for it in our [issues][github-issues].
2016-07-20 11:18:28 -07:00
If you do not see your issue captured, please file a [new issue][new-issue]. For more details see [Contributing to issues][contribution-issues].
2016-06-24 11:18:01 -07:00
2016-06-22 16:57:17 -07:00
PowerShell Community
--------------------
`TODO` Missing community details
2015-07-01 15:06:29 -07:00
2016-06-22 16:57:17 -07:00
Legal and Licensing
-------------------
2016-06-23 08:21:07 -07:00
2016-06-22 16:57:17 -07:00
`TODO` Missing license details
2016-06-23 08:21:07 -07:00
`TODO` Missing link to contributor agreement
2016-06-24 10:47:46 -07:00
Code of Conduct
---------------
2016-07-19 02:16:00 +02:00
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.
2016-06-24 10:47:46 -07:00
2016-07-19 15:18:55 -07:00
[artifacts]: https://ci.appveyor.com/project/PowerShell/powershell/build/artifacts
[build-linux]: docs/building/linux.md
[build-osx]: docs/building/osx.md
[build-wc]: docs/building/windows-core.md
[build-wf]: docs/building/windows-full.md
2016-06-24 10:47:46 -07:00
[conduct-code]: http://opensource.microsoft.com/codeofconduct/
[conduct-email]: mailto:opencode@microsoft .com
2016-07-19 15:18:55 -07:00
[conduct-FAQ]: http://opensource.microsoft.com/codeofconduct/faq/
[contribution]: .github/CONTRIBUTING.md
2016-07-20 11:18:28 -07:00
[contribution-issues]: .github/CONTRIBUTING.md#contributing -to-issues
2016-07-19 15:18:55 -07:00
[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
[pls-omi-provider]: https://github.com/PowerShell/psl-omi-provider
[releases]: https://github.com/PowerShell/PowerShell/releases
