PowerShell7/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
--------------

1. Download the package for your platform at [PowerShell Releases][releases].
1. Install the package. 
   * [Linux or OS X][inst-linux].
   * [Windows][inst-win].

Building PowerShell
-------------------

| Linux | Windows  | OS X |
|-------|----------|------|
| [Instructions][build-linux] | [Instructions][build-wc] | [Instructions][build-osx] |

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.

```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
```
See [working with the PowerShell repository][powershell-repo-101] for more information.

Developing and Contributing
--------------------------

Please see the [Contribution Guide][contribution] 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 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

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.

[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
WIP initial draft of readme 2016-06-22 23:57:17 +00:00			`![PowerShell Logo](assets/Powershell_64.png) PowerShell`
			`========================`
Add a readme 2015-07-01 22:06:29 +00:00
(WIP) Updated draft of readme for PM review. 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`
Update PowerShell/README.md Fixed casing and a couple of typos. Added newlines following one-sentence-per-line principle. 2016-07-19 00:16:00 +00:00			`using the [.NET Command-Line Interface](https://github.com/dotnet/cli).`
(WIP) Updated draft of readme for PM review. 2016-06-23 15:21:07 +00:00			`PowerShell provides full access to COM and WMI, enabling administrators to`
Update PowerShell/README.md Fixed casing and a couple of typos. Added newlines following one-sentence-per-line principle. 2016-07-19 00:16:00 +00:00			`automate administrative tasks on both local and remote Windows, Linux, and OS X systems.`
Add build instructions matrix to readme 2016-03-30 22:13:29 +00:00
Updated per feedback. 2016-06-24 18:18:01 +00:00			`New to PowerShell?`
			`------------------`
(WIP) Updated draft of readme for PM review. 2016-06-23 15:21:07 +00:00			`If you are new to PowerShell and would like to learn more, we recommend`
Updated per feedback. 2016-06-24 18:18:01 +00:00			`reviewing the [getting started documentation][getting-started].`

updated link in readme 2016-07-12 20:27:21 +00:00			`[getting-started]: docs/learning-powerShell/learning-powershell.md`
Add build instructions matrix to readme 2016-03-30 22:13:29 +00:00
Refactor readme header 2016-03-30 19:06:57 +00: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 19:36:23 +00:00
Remove server2016 from the build status matrix [skip ci] 2016-04-06 18:32:10 +00: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 18:25:09 +00: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 07:16:41 +00: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 19:06:57 +00:00
Add build instructions matrix to readme 2016-03-30 22:13:29 +00:00			`Get PowerShell`
			`--------------`

Clarified the Get PowerShell instructions 2016-07-20 18:36:06 +00:00			`1. Download the package for your platform at [PowerShell Releases][releases].`
Formatting in top-level README.md - Remove redundant 'Build from Source' column, since the Section name already implies it - Lists with 1 bullet-point are weird-looking, especially sub-lists 2016-07-27 06:56:46 +00:00			`1. Install the package.`
			`* [Linux or OS X][inst-linux].`
			`* [Windows][inst-win].`
Updated per feedback. 2016-06-24 18:18:01 +00:00
Drafted update to contribution guidelines 2016-07-19 22:18:10 +00:00			`Building PowerShell`
			`-------------------`
update some wording 2016-07-13 22:59:08 +00:00
Formatting in top-level README.md - Remove redundant 'Build from Source' column, since the Section name already implies it - Lists with 1 bullet-point are weird-looking, especially sub-lists 2016-07-27 06:56:46 +00:00			`\| Linux \| Windows \| OS X \|`
			`\|-------\|----------\|------\|`
			`\| [Instructions][build-linux] \| [Instructions][build-wc] \| [Instructions][build-osx] \|`
Add explicit dependency instructions to README 2016-01-21 20:25:48 +00:00
added "recursive cloning" back to readme per request #1197 2016-07-21 00:09:41 +00:00			`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.`

			```sh
			`git clone --recursive https://github.com/PowerShell/PowerShell.git`
			```
Updated the Downloading Source code section to address the feedback from lzybkr. 2016-07-21 00:23:06 +00:00
			If you already cloned but forgot to use `--recursive`, you can update submodules manually:
			```sh
			`git submodule init`
			`git submodule update`
			```
added "recursive cloning" back to readme per request #1197 2016-07-21 00:09:41 +00:00			`See [working with the PowerShell repository][powershell-repo-101] for more information.`

Drafted update to contribution guidelines 2016-07-19 22:18:10 +00:00			`Developing and Contributing`
			`--------------------------`
Simplified over complicated table into single link. Removed redundant contributing text and replaced with link to contributing doc. Removed maitaner specific text and replaced with link to contributor specific section for the topic 2016-07-20 18:18:28 +00:00
			`Please see the [Contribution Guide][contribution] for how to develop and contribute.`
Update README.md Add more info about git on windows [no ci] 2016-03-09 22:24:15 +00: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 16:42:22 +00:00			`If you encounter issues in your development, please consult the [known issues][known-issues]`
Updated per feedback. 2016-06-24 18:18:01 +00: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 15:21:07 +00:00			`captured and if a workaround exists.`
Update README.md Add more info about git on windows [no ci] 2016-03-09 22:24:15 +00:00
added "recursive cloning" back to readme per request #1197 2016-07-21 00:09:41 +00:00			`If you encounter issues with PowerShell itself, first search for it in our [issues][github-issues].`
Simplified over complicated table into single link. Removed redundant contributing text and replaced with link to contributing doc. Removed maitaner specific text and replaced with link to contributor specific section for the topic 2016-07-20 18:18:28 +00: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].`
Updated per feedback. 2016-06-24 18:18:01 +00:00
WIP initial draft of readme 2016-06-22 23:57:17 +00:00			`PowerShell Community`
			`--------------------`
			`TODO` Missing community details
Update Git setup documentation Now that everyone needs all the submodules. Much simpler. 2016-04-12 23:16:17 +00:00
WIP initial draft of readme 2016-06-22 23:57:17 +00:00			`Legal and Licensing`
			`-------------------`
(WIP) Updated draft of readme for PM review. 2016-06-23 15:21:07 +00:00
WIP initial draft of readme 2016-06-22 23:57:17 +00:00			`TODO` Missing license details
(WIP) Updated draft of readme for PM review. 2016-06-23 15:21:07 +00:00
			`TODO` Missing link to contributor agreement
Add official Microsoft Open Source Code of Conduct 2016-06-24 17:47:46 +00:00
			`Code of Conduct`
			`---------------`

added "recursive cloning" back to readme per request #1197 2016-07-21 00:09:41 +00:00			`This project has adopted the [Microsoft Open Source Code of Conduct][conduct-code].`
Update PowerShell/README.md Fixed casing and a couple of typos. Added newlines following one-sentence-per-line principle. 2016-07-19 00:16:00 +00:00			`For more information see the [Code of Conduct FAQ][conduct-FAQ] or contact`
			`[opencode@microsoft.com][conduct-email] with any additional questions or comments.`
Add official Microsoft Open Source Code of Conduct 2016-06-24 17:47:46 +00:00
Addressed @jianyun `s and @vor 's PR comments 2016-07-19 22:18:55 +00:00			`[build-linux]: docs/building/linux.md`
			`[build-osx]: docs/building/osx.md`
			`[build-wc]: docs/building/windows-core.md`
Add official Microsoft Open Source Code of Conduct 2016-06-24 17:47:46 +00:00			`[conduct-code]: http://opensource.microsoft.com/codeofconduct/`
			`[conduct-email]: mailto:opencode@microsoft.com`
Addressed @jianyun `s and @vor 's PR comments 2016-07-19 22:18:55 +00:00			`[conduct-FAQ]: http://opensource.microsoft.com/codeofconduct/faq/`
			`[contribution]: .github/CONTRIBUTING.md`
Simplified over complicated table into single link. Removed redundant contributing text and replaced with link to contributing doc. Removed maitaner specific text and replaced with link to contributor specific section for the topic 2016-07-20 18:18:28 +00:00			`[contribution-issues]: .github/CONTRIBUTING.md#contributing-to-issues`
Addressed @jianyun `s and @vor 's PR comments 2016-07-19 22:18:55 +00: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`
			`[releases]: https://github.com/PowerShell/PowerShell/releases`
added "recursive cloning" back to readme per request #1197 2016-07-21 00:09:41 +00:00			`[powershell-repo-101]: docs/git/powershell-repository-101.md`