PowerShell/README.md

PowerShell
==========

This repository is "Project Magrathea": Open PowerShell on GitHub, for
Linux, Windows (.NET Core and Full), and OS X. It is built using the
[.NET Command Line Interface][dotnet-cli] to support targetting every
flavor of PowerShell. It is a collaborative effort among many teams:

- Full PowerShell
- Core PowerShell
- Open Source Technology Center
- .NET Foundation

[dotnet-cli]: https://github.com/dotnet/cli

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](docs/building/linux.md) | [Instructions](docs/building/windows-core.md) | [Instructions](docs/building/windows-full.md) | [Instructions](docs/building/osx.md) | [Instructions][psrp] |
| Get **Binaries**      | [Releases][] | [Artifacts][] | [Artifacts][] | [Releases][] | TBD |

Building summary: `Start-PSBuild` from the module
`./build.psm1` (self-host on Linux / OS X)

See [Linux releases](docs/installation/linux.md) and
[Windows artifacts](docs/installation/windows.md) installation
instructions.

[releases]: https://github.com/PowerShell/PowerShell/releases
[artifacts]: https://ci.appveyor.com/project/PowerShell/powershell-linux/build/artifacts
[psrp]: https://github.com/PowerShell/psl-omi-provider

Team coordination
-----------------

- [PSCore Slack chat](https://pscore.slack.com/)
- [Waffle.io scrum board](https://waffle.io/PowerShell/PowerShell)
- [VSO items](https://aka.ms/openps)
- [PowerShell subsystem maintainers](https://aka.ms/psowners)
- [Automation Sharepoint](https://aka.ms/pscore)
- [Internal Open PowerShell Documents](https://github.com/PowerShell/Internal-PowerShellTeam-Tools/tree/master/OpenPowerShellDocs)

If you encounter any problems, see the [known issues](KNOWNISSUES.md),
search the [issues][], and if all else fails, open a new issue.

[issues]: https://github.com/PowerShell/PowerShell/issues

Obtain the source code
----------------------

### Setup Git

Install [Git][], the version control system.

See the [Contributing Guidelines](.github/CONTRIBUTING.md) for more Git
information, such as our installation instructions, contributing
rules, and Git best practices.

[Git]: https://git-scm.com/documentation

### Download source code

Clone this repository. It is a "superproject" and has a number of
other repositories embedded within it as submodules. *Please* see the
contributing guidelines and learn about submodules. To make things
easy, we can just clone recursively.

```sh
git clone --recursive https://github.com/PowerShell/PowerShell.git
```
Refactor readme header 2016-03-30 21:06:57 +02:00			`PowerShell`
			`==========`
Add a readme 2015-07-02 00:06:29 +02:00
Add build instructions matrix to readme 2016-03-31 00:13:29 +02:00			`This repository is "Project Magrathea": Open PowerShell on GitHub, for`
			`Linux, Windows (.NET Core and Full), and OS X. It is built using the`
			`[.NET Command Line Interface][dotnet-cli] to support targetting every`
			`flavor of PowerShell. It is a collaborative effort among many teams:`

			`- Full PowerShell`
			`- Core PowerShell`
			`- Open Source Technology Center`
			`- .NET Foundation`

			`[dotnet-cli]: https://github.com/dotnet/cli`

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 \|`
			`\|-----------------------\|-------\|-------------------\|-------------------\|------\|------\|`
Redirect PSRP documentation to other repo 2016-04-13 00:59:38 +02:00			`\| Build from Source \| [Instructions](docs/building/linux.md) \| [Instructions](docs/building/windows-core.md) \| [Instructions](docs/building/windows-full.md) \| [Instructions](docs/building/osx.md) \| [Instructions][psrp] \|`
Move PSRP notes 2016-03-31 00:57:52 +02:00			`\| Get Binaries \| [Releases][] \| [Artifacts][] \| [Artifacts][] \| [Releases][] \| TBD \|`
Add build instructions matrix to readme 2016-03-31 00:13:29 +02:00
			Building summary: `Start-PSBuild` from the module
Rename PowerShellGitHubDev.psm1 to build.psm1 2016-05-18 22:58:59 +02:00			`./build.psm1` (self-host on Linux / OS X)
Add build instructions matrix to readme 2016-03-31 00:13:29 +02:00
Add Linux and Windows installation instructions 2016-03-31 08:29:16 +02:00			`See [Linux releases](docs/installation/linux.md) and`
			`[Windows artifacts](docs/installation/windows.md) installation`
			`instructions.`

Add build instructions matrix to readme 2016-03-31 00:13:29 +02:00			`[releases]: https://github.com/PowerShell/PowerShell/releases`
			`[artifacts]: https://ci.appveyor.com/project/PowerShell/powershell-linux/build/artifacts`
Redirect PSRP documentation to other repo 2016-04-13 00:59:38 +02:00			`[psrp]: https://github.com/PowerShell/psl-omi-provider`
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			`Team coordination`
			`-----------------`

			`- [PSCore Slack chat](https://pscore.slack.com/)`
			`- [Waffle.io scrum board](https://waffle.io/PowerShell/PowerShell)`
Add Core PS links 2016-04-21 23:22:06 +02:00			`- [VSO items](https://aka.ms/openps)`
			`- [PowerShell subsystem maintainers](https://aka.ms/psowners)`
Add team coordination link to internal docs 2016-05-18 19:47:13 +02:00			`- [Automation Sharepoint](https://aka.ms/pscore)`
			`- [Internal Open PowerShell Documents](https://github.com/PowerShell/Internal-PowerShellTeam-Tools/tree/master/OpenPowerShellDocs)`
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
Add build instructions matrix to readme 2016-03-31 00:13:29 +02:00			`If you encounter any problems, see the [known issues](KNOWNISSUES.md),`
			`search the [issues][], and if all else fails, open a new issue.`

			`[issues]: https://github.com/PowerShell/PowerShell/issues`

Add Linux and Windows installation instructions 2016-03-31 08:29:16 +02:00			`Obtain the source code`
			`----------------------`
Add a readme 2015-07-02 00:06:29 +02:00
Some readme cleanups 2015-10-08 22:44:37 +02:00			`### Setup Git`
Add a readme 2015-07-02 00:06:29 +02:00
Add explicit dependency instructions to README 2016-01-21 21:25:48 +01:00			`Install [Git][], the version control system.`

Move CONTRIBUTING.md into .github folder 2016-04-22 23:37:26 +02:00			`See the [Contributing Guidelines](.github/CONTRIBUTING.md) for more Git`
Move Git installation instructions to contributing The readme is getting quite large, so in an effort to shorten it, the Git installation instructions (which have nothing to do with PowerShell, but are helpful for new users), are now in `CONTRIBUTING.md`. Thus, if someone is totally new to Git, they will be far more likely to review our contributing guidelines, and so read our rules and best practices. Cloning the source code was cleaned up so that initializing the submodules is done in a separate step. This simplifies the first step, making it more likely to succeed (and narrowing the possible failures). 2016-03-14 20:03:04 +01:00			`information, such as our installation instructions, contributing`
			`rules, and Git best practices.`
Update README.md Add more info about git on windows [no ci] 2016-03-09 23:24:15 +01:00
Move Git installation instructions to contributing The readme is getting quite large, so in an effort to shorten it, the Git installation instructions (which have nothing to do with PowerShell, but are helpful for new users), are now in `CONTRIBUTING.md`. Thus, if someone is totally new to Git, they will be far more likely to review our contributing guidelines, and so read our rules and best practices. Cloning the source code was cleaned up so that initializing the submodules is done in a separate step. This simplifies the first step, making it more likely to succeed (and narrowing the possible failures). 2016-03-14 20:03:04 +01:00			`[Git]: https://git-scm.com/documentation`
Update README.md Add more info about git on windows [no ci] 2016-03-09 23:24:15 +01:00
Move Git installation instructions to contributing The readme is getting quite large, so in an effort to shorten it, the Git installation instructions (which have nothing to do with PowerShell, but are helpful for new users), are now in `CONTRIBUTING.md`. Thus, if someone is totally new to Git, they will be far more likely to review our contributing guidelines, and so read our rules and best practices. Cloning the source code was cleaned up so that initializing the submodules is done in a separate step. This simplifies the first step, making it more likely to succeed (and narrowing the possible failures). 2016-03-14 20:03:04 +01:00			`### Download source code`
Add explicit dependency instructions to README 2016-01-21 21:25:48 +01:00
Move Git installation instructions to contributing The readme is getting quite large, so in an effort to shorten it, the Git installation instructions (which have nothing to do with PowerShell, but are helpful for new users), are now in `CONTRIBUTING.md`. Thus, if someone is totally new to Git, they will be far more likely to review our contributing guidelines, and so read our rules and best practices. Cloning the source code was cleaned up so that initializing the submodules is done in a separate step. This simplifies the first step, making it more likely to succeed (and narrowing the possible failures). 2016-03-14 20:03:04 +01:00			`Clone this repository. It is a "superproject" and has a number of`
			`other repositories embedded within it as submodules. Please see the`
Update Git setup documentation Now that everyone needs all the submodules. Much simpler. 2016-04-13 01:16:17 +02:00			`contributing guidelines and learn about submodules. To make things`
			`easy, we can just clone recursively.`

			```sh
			`git clone --recursive https://github.com/PowerShell/PowerShell.git`
			```