2016-03-30 21:06:57 +02:00
PowerShell
==========
2015-07-02 00:06:29 +02:00
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
2016-03-30 21:06:57 +02:00
Build Status
------------
2016-01-22 20:36:23 +01:00
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) |
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) |
2016-04-06 20:32:10 +02:00
| Windows | [![Build status ](https://ci.appveyor.com/api/projects/status/wb0a0apbn4aiccp1/branch/master?svg=true )](https://ci.appveyor.com/project/PowerShell/powershell-linux/branch/master) |
2016-03-30 21:06:57 +02:00
2016-03-31 00:13:29 +02:00
Get PowerShell
--------------
2016-03-31 00:57:52 +02:00
| | Linux | Windows .NET Core | Windows .NET Full | OS X | PSRP |
|-----------------------|-------|-------------------|-------------------|------|------|
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] |
2016-03-31 00:57:52 +02:00
| Get **Binaries** | [Releases][] | [Artifacts][] | [Artifacts][] | [Releases][] | TBD |
2016-03-31 00:13:29 +02:00
Building summary: `Start-PSBuild` from the module
`./PowerShellGitHubDev.psm1` (self-host on Linux / OS X)
2016-03-31 08:29:16 +02:00
See [Linux releases ](docs/installation/linux.md ) and
[Windows artifacts ](docs/installation/windows.md ) installation
instructions.
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
2016-04-13 00:59:38 +02:00
[psrp]: https://github.com/PowerShell/psl-omi-provider
2016-03-31 00:13:29 +02:00
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 )
2016-01-22 20:36:23 +01:00
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
2016-03-31 08:29:16 +02:00
Obtain the source code
----------------------
2015-07-02 00:06:29 +02:00
2015-10-08 22:44:37 +02:00
### Setup Git
2015-07-02 00:06:29 +02:00
2016-01-21 21:25:48 +01:00
Install [Git][], the version control system.
2016-03-14 20:03:04 +01:00
See the [Contributing Guidelines ](CONTRIBUTING.md ) for more Git
information, such as our installation instructions, contributing
rules, and Git best practices.
2016-03-09 23:24:15 +01:00
2016-03-14 20:03:04 +01:00
[Git]: https://git-scm.com/documentation
2016-03-09 23:24:15 +01:00
2016-03-14 20:03:04 +01:00
### Download source code
2016-01-21 21:25:48 +01:00
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
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
```
You can verify that the submodules were initialized properly with:
```sh
git submodule status
```
If they're initialized, it will look like this:
```
f23641488f8d7bf8630ca3496e61562aa3a64009 src/Modules/Pester (f23641488)
c99458533a9b4c743ed51537e25989ea55944908 src/libpsl-native/test/googletest (release-1.7.0)
e6bf85694ae8352d77175c4c7d304946e018808c src/windows-build (monad/cc6afbeb-3/31)
```
If they're not, there will be minuses in front (and the folders will
be empty):
```
-f23641488f8d7bf8630ca3496e61562aa3a64009 src/Modules/Pester (f23641488)
-c99458533a9b4c743ed51537e25989ea55944908 src/libpsl-native/test/googletest (release-1.7.0)
-e6bf85694ae8352d77175c4c7d304946e018808c src/windows-build (monad/cc6afbeb-3/31)
```