2016-06-22 23:57:17 +00:00
 PowerShell
========================
2015-07-01 22:06:29 +00:00
2016-06-23 15:21:07 +00: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
2016-06-24 18:18:01 +00:00
automate administrative tasks on both local and remote Windows, Linux and OS X systems.
2016-03-30 22:13:29 +00:00
2016-06-24 18:18:01 +00:00
New to PowerShell?
------------------
2016-06-23 15:21:07 +00:00
If you are new to PowerShell and would like to learn more, we recommend
2016-06-24 18:18:01 +00:00
reviewing the [getting started documentation][getting-started].
[getting-started]: https://msdn.microsoft.com/en-us/powershell/scripting/getting-started/getting-started-with-windows-powershell
2016-03-30 22:13:29 +00:00
2016-03-30 19:06:57 +00:00
Build Status
------------
2016-01-22 19:36:23 +00:00
2016-04-06 18:32:10 +00:00
| Platform | `master` |
|--------------|----------|
| Ubuntu 14.04 | [](https://travis-ci.com/PowerShell/PowerShell) |
2016-04-14 18:25:09 +00:00
| OS X 10.11 | [](https://travis-ci.com/PowerShell/PowerShell) |
2016-05-22 07:16:41 +00:00
| Windows | [](https://ci.appveyor.com/project/PowerShell/powershell/branch/master) |
2016-03-30 19:06:57 +00:00
2016-03-30 22:13:29 +00:00
Get PowerShell
--------------
2016-03-30 22:57:52 +00:00
| | Linux | Windows .NET Core | Windows .NET Full | OS X | PSRP |
|-----------------------|-------|-------------------|-------------------|------|------|
2016-06-24 18:18:01 +00: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 |
2015-07-01 22:06:29 +00:00
2016-06-23 15:21:07 +00:00
If installing PowerShell from a package, please refer to the installation
2016-06-24 18:18:01 +00: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
2015-07-01 22:06:29 +00:00
2016-06-22 23:57:17 +00:00
Developing and Contributing
--------------------------
2016-06-24 18:18:01 +00: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
instructions, cheat sheets and links to our favorite Git tutorials. We also
recommend, reviewing an example of a [basic Git commit walkthrough][git-commit].
2016-01-21 20:25:48 +00:00
2016-06-23 15:21:07 +00:00
To begin development, you'll need to setup your development environment for
2016-06-24 18:18:01 +00:00
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
2016-06-23 15:21:07 +00:00
requirements and coding guidelines.
2016-03-09 22:24:15 +00:00
2016-06-24 18:18:01 +00:00
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
2016-06-23 15:21:07 +00:00
captured and if a workaround exists.
2016-03-09 22:24:15 +00:00
2016-06-24 18:18:01 +00:00
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
2016-06-24 23:49:24 +00:00
[contribution]: .github/CONTRIBUTING.md
2016-06-24 18:18:01 +00:00
[known-issues]: docs/KNOWNISSUES.md
[faq]: docs/FAQ.md
[new-issue]:https://github.com/PowerShell/PowerShell/issues/new
2016-01-21 20:25:48 +00:00
2016-06-22 23:57:17 +00:00
PowerShell Community
--------------------
`TODO` Missing community details
2016-04-12 23:16:17 +00:00
2016-06-22 23:57:17 +00:00
Legal and Licensing
-------------------
2016-06-23 15:21:07 +00:00
2016-06-22 23:57:17 +00:00
`TODO` Missing license details
2016-06-23 15:21:07 +00:00
`TODO` Missing link to contributor agreement
2016-06-24 17:47:46 +00: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
