Skip to content

Update building instruction #5209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sharpchen (sharpchen) wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update building instruction #5209

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,16 +151,16 @@ Please see the [Contribution Guide][] for how to develop and contribute.
To build `PSReadLine` on Windows, Linux, or macOS,
you must have the following installed:

* .NET 6.0 or [a newer version](https://www.microsoft.com/net/download)
* A dotnet version satisfying what `global.json` requires, see: [global.json Matching Rules][]
* The PowerShell modules `InvokeBuild` and `platyPS`

The build script `build.ps1` can be used to bootstrap, build and test the project.

* Bootstrap: `./build.ps1 -Bootstrap`
* Build: `./build.ps1 -Configuration Debug`
* Test:
* Targeting .NET 4.7.2 (Windows only): `./build.ps1 -Test -Configuration Debug -Framework net472`
* Targeting .NET 6.0: `./build.ps1 -Test -Configuration Debug -Framework net6.0`
* Test: `./build.ps1 -Test -Configuration Debug`, currently tests are only available to run on Windows.
<!-- * Targeting .NET 4.7.2 (Windows only): `./build.ps1 -Test -Configuration Debug -Framework net472` -->
<!-- * Targeting .NET 6.0: `./build.ps1 -Test -Configuration Debug -Framework net6.0` -->

After build, the produced artifacts can be found at `<your-local-repo-root>/bin/Debug`.

Expand All @@ -186,3 +186,4 @@ For any security issues, please see our [Security Policy](.github/SECURITY.md).

[Contribution Guide]: https://github.com/PowerShell/PSReadLine/blob/master/.github/CONTRIBUTING.md
[2-Clause BSD License]: https://github.com/PowerShell/PSReadLine/blob/master/License.txt
[global.json Matching Rules]: https://learn.microsoft.com/en-us/dotnet/core/tools/global-json#matching-rules