Skip to content

Update README.md #316

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

Merged
NikolaMilosavljevic merged 1 commit into from
Dec 1, 2023
Merged

Update README.md #316

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
12 changes: 5 additions & 7 deletions Documentation/dotnet-mage/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

dotnet-mage (previously also known as Mage.NET) is the open-sourced version of the familiar .NET FX tool Mage.

It is available at Nuget.org. Latest version `https://www.nuget.org/packages/Microsoft.DotNet.Mage/7.0.0`

First version of the tool (`https://www.nuget.org/packages/Microsoft.DotNet.Mage/5.0.0-rc.2.20513.1`) had a different tool name 'mage.net' - if you are using that version, you would need to modify the commands listed in this document accordingly - use 'mage.net' instead of 'dotnet mage'.
It is available at Nuget.org. Latest version `https://www.nuget.org/packages/Microsoft.DotNet.Mage/8.0.0`

dotnet-mage supports all existing command-line options of the old Mage tool, with few exceptions:
- no support for partial trust
Expand All @@ -22,17 +20,17 @@ Adds Launcher to target directory and sets binary to be launched.
Example:
`-AddLauncher myapp.dll -TargetDirectory bin/release`

Launcher is required for all .NET 7, .NET 6, .NET 5 (and .NET Core 3.1) apps in ClickOnce.
Launcher is required for all .NET 8, .NET 7, .NET 6, .NET 5 (and .NET Core 3.1) apps in ClickOnce.

You can obtain all command-line options by running `dotnet mage` or for verbose help `dotnet mage -help verbose`.

## Prerequisites for using this tool

* [Install .NET 7 SDK](https://dotnet.microsoft.com/download/dotnet/7.0)
* [Install .NET 8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0)

* Install dotnet-mage global tool:

`dotnet tool install --global microsoft.dotnet.mage --version 7.0.0`
`dotnet tool install --global microsoft.dotnet.mage --version 8.0.0`

dotnet-mage is fully supported on Windows (we are gathering feedback about scenarios for dotnet-mage usage on Linux build agents).

Expand All @@ -45,7 +43,7 @@ dotnet-mage is fully supported on Windows (we are gathering feedback about scena

## Example steps

Suppose that we have copied project output to a sub-folder `files` and our .NET 7 application entry point is `myapp.exe`
Suppose that we have copied project output to a sub-folder `files` and our .NET 8 application entry point is `myapp.exe`

* Add Launcher

Expand Down