mirror of
https://github.com/PowerShell/PowerShell
synced 2026-06-08 12:12:50 +00:00
fix Markdown formatting to follow one-sentence-per-line recommendation (#2080)
This commit is contained in:
committed by
Jason Shirk
parent
303abdd87b
commit
71b9a75de6
@@ -1,9 +1,8 @@
|
||||
Build PowerShell on Windows for .NET Core
|
||||
=========================================
|
||||
|
||||
This guide will walk you through building PowerShell on Windows,
|
||||
targeting .NET Core. We'll start by showing how to set up your
|
||||
environment from scratch.
|
||||
This guide will walk you through building PowerShell on Windows, targeting .NET Core.
|
||||
We'll start by showing how to set up your environment from scratch.
|
||||
|
||||
You can also [build PowerShell for Full .NET framework](windows-full.md) on Windows.
|
||||
|
||||
@@ -20,13 +19,13 @@ Using Git requires it to be setup correctly; refer to the
|
||||
[README](../../README.md) and
|
||||
[Contributing Guidelines](../../.github/CONTRIBUTING.md).
|
||||
|
||||
This guide assumes that you have recursively cloned the PowerShell
|
||||
repository and `cd`ed into it.
|
||||
This guide assumes that you have recursively cloned the PowerShell repository and `cd`ed into it.
|
||||
|
||||
Visual Studio
|
||||
----------------
|
||||
|
||||
You will need to install an edition of Visual Studio 2015 (Community, Enterprise, or Professional) with the optional feature 'Common Tools for Visual C++' installed. The free Community edition of Visual Studio 2015 can be downloaded [here](https://www.visualstudio.com/visual-studio-community-vs/).
|
||||
You will need to install an edition of Visual Studio 2015 (Community, Enterprise, or Professional) with the optional feature 'Common Tools for Visual C++' installed.
|
||||
The free Community edition of Visual Studio 2015 can be downloaded [here](https://www.visualstudio.com/visual-studio-community-vs/).
|
||||
|
||||
.NET CLI
|
||||
--------
|
||||
@@ -46,8 +45,7 @@ Invoke-WebRequest -Uri https://raw.githubusercontent.com/dotnet/cli/rel/1.0.0/sc
|
||||
./install.ps1
|
||||
```
|
||||
|
||||
If you have any problems installing `dotnet`,
|
||||
please see their [documentation][cli-docs].
|
||||
If you have any problems installing `dotnet`, please see their [documentation][cli-docs].
|
||||
|
||||
[dotnet-cli]: https://github.com/dotnet/cli#new-to-net-cli
|
||||
[cli-docs]: https://dotnet.github.io/getting-started/
|
||||
@@ -55,37 +53,35 @@ please see their [documentation][cli-docs].
|
||||
Build using our module
|
||||
======================
|
||||
|
||||
We maintain a [PowerShell module](../../build.psm1) with
|
||||
the function `Start-PSBuild` to build PowerShell.
|
||||
We maintain a [PowerShell module](../../build.psm1) with the function `Start-PSBuild` to build PowerShell.
|
||||
|
||||
```powershell
|
||||
Import-Module ./build.psm1
|
||||
Start-PSBuild
|
||||
```
|
||||
|
||||
Congratulations! If everything went right, PowerShell is now built and
|
||||
executable as `./src/powershell-win-core/bin/Debug/netcoreapp1.0/win10-x64/powershell`.
|
||||
Congratulations! If everything went right, PowerShell is now built and executable as `./src/powershell-win-core/bin/Debug/netcoreapp1.0/win10-x64/powershell`.
|
||||
|
||||
This location is of the form
|
||||
`./[project]/bin/[configuration]/[framework]/[rid]/[binary name]`, and our
|
||||
project is `powershell`, configuration is `Debug` by default, framework is
|
||||
`netcoreapp1.0`, runtime identifier is **probably** `win10-x64` (but will depend
|
||||
on your operating system; don't worry, `dotnet --info` will tell you what it
|
||||
was), and binary name is `powershell`. The function `Get-PSOutput` will return
|
||||
the path to the executable; thus you can execute the development copy via `&
|
||||
(Get-PSOutput)`.
|
||||
This location is of the form `./[project]/bin/[configuration]/[framework]/[rid]/[binary name]`,
|
||||
and our project is `powershell`, configuration is `Debug` by default,
|
||||
framework is `netcoreapp1.0`, runtime identifier is **probably** `win10-x64`
|
||||
(but will depend on your operating system;
|
||||
don't worry, `dotnet --info` will tell you what it was), and binary name is `powershell`.
|
||||
The function `Get-PSOutput` will return the path to the executable;
|
||||
thus you can execute the development copy via `& (Get-PSOutput)`.
|
||||
|
||||
The `powershell` project is the .NET Core PowerShell host. It is the top level
|
||||
project, so `dotnet build` transitively builds all its dependencies, and emits a
|
||||
`powershell` executable. The cross-platform host has built-in documentation via
|
||||
`--help`.
|
||||
The `powershell` project is the .NET Core PowerShell host.
|
||||
It is the top level project, so `dotnet build` transitively builds all its dependencies,
|
||||
and emits a `powershell` executable.
|
||||
The cross-platform host has built-in documentation via `--help`.
|
||||
|
||||
You can run our cross-platform Pester tests with `Start-PSPester`.
|
||||
|
||||
Building in Visual Studio
|
||||
-----------------------------
|
||||
|
||||
We do not recommend building the PowerShell solution from Visual Studio. This may lead to package version mismatches with errors similar to:
|
||||
We do not recommend building the PowerShell solution from Visual Studio.
|
||||
This may lead to package version mismatches with errors similar to:
|
||||
```
|
||||
C:\dev\powershell\src\System.Management.Automation\project.json(142,77): error NU1001: The dependency Microsoft.PowerShe
|
||||
ll.CoreCLR.AssemblyLoadContext >= 1.0.0-* could not be resolved.
|
||||
|
||||
Reference in New Issue
Block a user