(WIP) Updated draft of readme for PM review.

This commit is contained in:
Don Gill committed 2016-06-23 08:21:07 -07:00
1 parent cc8e7a789e
commit 178becf21e
1 file changed
+29 -18
+29 -18
View File
@@ -1,13 +1,15 @@
![PowerShell Logo](assets/Powershell_64.png) PowerShell ![PowerShell Logo](assets/Powershell_64.png) PowerShell
======================== ========================
PowerShell is a task automation and configuration management framework, 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). consisting of a command-line shell and associated scripting language built
PowerShell provides full access to COM and WMI, enabling administrators to perform administrative tasks on both local and remote Windows, Linux and OSX systems. 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 OSX systems.
## New to PowerShell? ## New to PowerShell?
If you are new to PowerShell and would like to learn more, If you are new to PowerShell and would like to learn more, we recommend
we recommend reviewing our [getting started documentation](https://msdn.microsoft.com/en-us/powershell/scripting/getting-started/getting-started-with-windows-powershell). reviewing the [getting started documentation](https://msdn.microsoft.com/en-us/powershell/scripting/getting-started/getting-started-with-windows-powershell).
Build Status Build Status
------------ ------------
@@ -23,26 +25,32 @@ Get PowerShell
| | Linux | Windows .NET Core | Windows .NET Full | OS X | PSRP | | | 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] | | 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](https://github.com/PowerShell/psl-omi-provider) |
| Get **Binaries** | [Releases][] | [Releases][] | [Artifacts][] | [Releases][] | TBD | | Get **Binaries** | [Releases](https://github.com/PowerShell/PowerShell/releases) | [Releases](https://github.com/PowerShell/PowerShell/releases) | [Artifacts](https://ci.appveyor.com/project/PowerShell/powershell/build/artifacts) | [Releases](https://github.com/PowerShell/PowerShell/releases) | TBD |
> Not sure what these are intended for...
[releases](https://github.com/PowerShell/PowerShell/releases)
[artifacts](https://ci.appveyor.com/project/PowerShell/powershell/build/artifacts)
[psrp](https://github.com/PowerShell/psl-omi-provider)
If installing PowerShell from a package, please refer to the installation
documents for [Linux](docs/installation/linux.md) and [Windows](docs/installation/windows.md).
Developing and Contributing Developing and Contributing
-------------------------- --------------------------
If you are new to GIT, we recommend you start by reviewing our [GIT basics document](docs/git/basics.md) where you will find installation instructions, cheatsheets and links to our favorite GIT tutorials. If you are new to GIT, we recommend you start by reviewing our
We also recommend, reviewing an example of a [basic GIT commit walkthrough](docs/git/committing.md). [GIT basics document](docs/git/basics.md) 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](docs/git/committing.md).
To begin development, you'll need to setup your development environment for either [Linux](docs/building/linux.md), [Windows](docs/building/windows.md) or [OSX]() and are encouraged to review our [coding guidelines and best practices](docs/coding-guidelines/coding.md) for contributors. To begin development, you'll need to setup your development environment for
either [Linux](docs/building/linux.md), [Windows](docs/building/windows.md) or
[OSX](docs/building/osx.md) and are encouraged to review the
[contribution guidelines](.github/CONTRIBUTING.md) for specific workflow, test
requirements and coding guidelines.
Review our [contribution guidelines](.github/CONTRIBUTING.md) for specific workflow and test requirements. If you encounter issues, please consult the [known issues](docs/KNOWNISSUES.md)
and [FAQ](docs/FAQ.md) documents to see if the issue you are running into is
captured and if a workaround exists.
If you encounter issues, please see our [known issues](docs/KNOWNISSUES.md) and [FAQ](docs/FAQ.md) documents. Alternatively, you can submit a [new issue](https://github.com/PowerShell/PowerShell/issues/new). If do not see your issue captured, please file a
[new issue](https://github.com/PowerShell/PowerShell/issues/new) using the
appropriate issue tag.
PowerShell Community PowerShell Community
-------------------- --------------------
@@ -50,4 +58,7 @@ PowerShell Community
Legal and Licensing Legal and Licensing
------------------- -------------------
`TODO` Missing license details `TODO` Missing license details
`TODO` Missing link to contributor agreement