|
1 | 1 | AppCore .NET Signing Tool |
2 | 2 | ------------------------- |
3 | 3 |
|
4 | | -<Build status> |
| 4 | +[](https://dev.azure.com/AppCoreNet/SigningTool/_build/latest?definitionId=14&branchName=dev) |
5 | 5 |
|
6 | | -<Project description> |
| 6 | +The AppCore .NET Signing Tool is a .NET CLI tool which can be used to sign assemblies. |
7 | 7 |
|
8 | | -## Packages |
| 8 | +The motivation behind this project is to provide a cross-platform replacement of the 'sn' tool provided |
| 9 | +by the classic .NET Framework. |
9 | 10 |
|
10 | | -Latest development packages can be found on [MyGet](https://www.myget.org/gallery/appcorenet). |
| 11 | +## Installation |
11 | 12 |
|
12 | | -Package | Description |
13 | | ---------------------------------------------------|------------------------------------------------------------------------------------------------------ |
| 13 | +The tool is distributed as a [NuGet](https://nuget.org) package and can be easily installed by invoking the following |
| 14 | +command: |
| 15 | + |
| 16 | +``` |
| 17 | +dotnet tool install -g AppCore.SigningTool |
| 18 | +``` |
| 19 | + |
| 20 | +## Usage |
| 21 | + |
| 22 | +The tool can be invoked using the command `dotnet-signtool`. If you need help about available |
| 23 | +commands and options add `--help` to the command line. |
| 24 | + |
| 25 | +### Quickstart |
| 26 | + |
| 27 | +The easiest way to add strong-naming to your assemblies is by signing them directly during the build. |
| 28 | + |
| 29 | +First, create a key pair using the following command: |
| 30 | + |
| 31 | +``` |
| 32 | +dotnet-signtool create-key my_key.snk |
| 33 | +``` |
| 34 | + |
| 35 | +Next, edit your project file and add the following tags: |
| 36 | + |
| 37 | +``` |
| 38 | +<PropertyGroup> |
| 39 | + <SignAssembly>true</SignAssembly> |
| 40 | + <AssemblyOriginatorKeyFile>my_key.snk</AssemblyOriginatorKeyFile> |
| 41 | +</PropertyGroup> |
| 42 | +``` |
| 43 | + |
| 44 | +For more information please read the [Microsoft Docs](https://docs.microsoft.com/en-us/dotnet/standard/assembly/strong-named) about |
| 45 | +strong-named assemblies. |
14 | 46 |
|
15 | 47 | ## Contributing |
16 | 48 |
|
17 | 49 | Contributions, whether you file an issue, fix some bug or implement a new feature, are highly appreciated. The whole user community |
18 | 50 | will benefit from them. |
19 | 51 |
|
| 52 | +If you want to try out the latest development version you can specify our [MyGet](https://www.myget.org/gallery/appcorenet) |
| 53 | +feed during installation: |
| 54 | + |
| 55 | +``` |
| 56 | +dotnet tool install -g AppCore.SigningTool --add-source https://www.myget.org/F/appcorenet/api/v3/index.json |
| 57 | +``` |
| 58 | + |
20 | 59 | Please refer to the [Contribution guide](CONTRIBUTING.md). |
0 commit comments