From cc8e7a789e451f7376ef2e3d7b3a05974fba869e Mon Sep 17 00:00:00 2001 From: Don Gill Date: Wed, 22 Jun 2016 16:57:17 -0700 Subject: [PATCH 1/3] WIP initial draft of readme --- README.md | 77 ++++++++++++++++++------------------------------------- 1 file changed, 25 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index febfbe5a8..5d8ecc278 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,13 @@ -PowerShell -========== +![PowerShell Logo](assets/Powershell_64.png) 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: +PowerShell is a task automation and configuration management framework, +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 perform administrative tasks on both local and remote Windows, Linux and OSX systems. -- Full PowerShell -- Core PowerShell -- Open Source Technology Center -- .NET Foundation - -[dotnet-cli]: https://github.com/dotnet/cli +## New to PowerShell? +If you are new to PowerShell and would like to learn more, +we recommend reviewing our [getting started documentation](https://msdn.microsoft.com/en-us/powershell/scripting/getting-started/getting-started-with-windows-powershell). Build Status ------------ @@ -30,51 +26,28 @@ Get PowerShell | 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][] | [Releases][] | [Artifacts][] | [Releases][] | TBD | -Building summary: `Start-PSBuild` from the module -`./build.psm1` (self-host on Linux / OS X) -See [Linux](docs/installation/linux.md) and -[Windows](docs/installation/windows.md) installation instructions. +> 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) -[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 -Team coordination ------------------ +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. +We also recommend, reviewing an example of a [basic GIT commit walkthrough](docs/git/committing.md). -- [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) +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. -If you encounter any problems, see the [known issues](KNOWNISSUES.md), -search the [issues][], and if all else fails, open a new issue. +Review our [contribution guidelines](.github/CONTRIBUTING.md) for specific workflow and test requirements. -[issues]: https://github.com/PowerShell/PowerShell/issues +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). -Obtain the source code ----------------------- +PowerShell Community +-------------------- +`TODO` Missing community details -### 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 -``` +Legal and Licensing +------------------- +`TODO` Missing license details From 178becf21e770bb65c8d090e3339040f63caac40 Mon Sep 17 00:00:00 2001 From: Don Gill Date: Thu, 23 Jun 2016 08:21:07 -0700 Subject: [PATCH 2/3] (WIP) Updated draft of readme for PM review. --- README.md | 47 +++++++++++++++++++++++++++++------------------ 1 file changed, 29 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 5d8ecc278..ab03375ac 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ ![PowerShell Logo](assets/Powershell_64.png) PowerShell ======================== -PowerShell is a task automation and configuration management framework, -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 perform administrative tasks on both local and remote Windows, Linux and OSX systems. +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 OSX systems. ## New to PowerShell? -If you are new to PowerShell and would like to learn more, -we recommend reviewing our [getting started documentation](https://msdn.microsoft.com/en-us/powershell/scripting/getting-started/getting-started-with-windows-powershell). +If you are new to PowerShell and would like to learn more, we recommend +reviewing the [getting started documentation](https://msdn.microsoft.com/en-us/powershell/scripting/getting-started/getting-started-with-windows-powershell). Build Status ------------ @@ -23,26 +25,32 @@ 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][] | [Releases][] | [Artifacts][] | [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) +| 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](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 | +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 -------------------------- -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. -We also recommend, reviewing an example of a [basic GIT commit walkthrough](docs/git/committing.md). +If you are new to GIT, we recommend you start by reviewing our +[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 -------------------- @@ -50,4 +58,7 @@ PowerShell Community Legal and Licensing ------------------- + `TODO` Missing license details + +`TODO` Missing link to contributor agreement From abc83b0e51e9b6011c23945f43d13beee758dfdc Mon Sep 17 00:00:00 2001 From: Don Gill Date: Fri, 24 Jun 2016 11:18:01 -0700 Subject: [PATCH 3/3] Updated per feedback. --- README.md | 56 +++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 38 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index ab03375ac..aef138f4d 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,14 @@ 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 OSX systems. +automate administrative tasks on both local and remote Windows, Linux and OS X systems. -## New to PowerShell? +New to PowerShell? +------------------ If you are new to PowerShell and would like to learn more, we recommend -reviewing the [getting started documentation](https://msdn.microsoft.com/en-us/powershell/scripting/getting-started/getting-started-with-windows-powershell). +reviewing the [getting started documentation][getting-started]. + +[getting-started]: https://msdn.microsoft.com/en-us/powershell/scripting/getting-started/getting-started-with-windows-powershell Build Status ------------ @@ -25,32 +28,49 @@ 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](https://github.com/PowerShell/psl-omi-provider) | -| 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 | +| 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 | If installing PowerShell from a package, please refer to the installation -documents for [Linux](docs/installation/linux.md) and [Windows](docs/installation/windows.md). +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 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 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). +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]. 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 +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 requirements and coding guidelines. -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 +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 captured and if a workaround exists. -If do not see your issue captured, please file a -[new issue](https://github.com/PowerShell/PowerShell/issues/new) using the -appropriate issue tag. +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 +[contribution]: .github/CONTRIBUTING.md) +[known-issues]: docs/KNOWNISSUES.md +[faq]: docs/FAQ.md +[new-issue]:https://github.com/PowerShell/PowerShell/issues/new + PowerShell Community --------------------