From c9cf78abdf9876b2aa4dbb3cc6e0cf5327ecc0cb Mon Sep 17 00:00:00 2001 From: Enrico Sada Date: Fri, 27 Oct 2017 14:49:09 +0200 Subject: [PATCH] update readme --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 48 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 54b4b9dd..52a0ab4b 100644 --- a/README.md +++ b/README.md @@ -3,19 +3,63 @@ - dotnet cli tool: `dotnet proj-info` - as library: `Dotnet.ProjInfo` -Support: +Features: - get properties - get project to project references - get fsc command line arguments +- list installed .NET Framework versions +- get references path of .NET asseblies like `System`, `System.Data` + +Support: -Support both dotnet/sdk style projects (slim proj, usually .net core) and old sdk projects (verbose proj, usually .NET) +- dotnet/sdk style projects (slim proj, usually .net core) +- old sdk projects (verbose proj, usually .NET) + +Runtimes: Works on mono and windows, and allow to specify the `dotnet` or `msbuild` to use -Add usual args of .NET cli, like `-c`, `-f`, `-r` +Notes: + +Add usual args of .NET cli, like `-c` (`--configuration`), `-f` (`--framework`), `-r` (`--runtime`) -see [examples](https://github.com/enricosada/dotnet-proj-info/tree/master/examples) directory +See [examples](https://github.com/enricosada/dotnet-proj-info/tree/master/examples) directory + +``` +USAGE: proj-info [--help] [--fsc-args] [--project-refs] [--get-property [...]] + [--net-fw-references-path [...]] [--installed-net-frameworks] [--framework ] + [--runtime ] [--configuration ] [--verbose] [--msbuild ] + [--dotnetcli ] [--msbuild-host ] [] + +PROJECT: + + the MSBuild project file + +OPTIONS: + + --fsc-args get fsc arguments + --project-refs get project references + --get-property, -gp [...] + msbuild property to get (allow multiple) + --net-fw-references-path [...] + list the .NET Framework references + --installed-net-frameworks + list of the installed .NET Frameworks + --framework, -f + target framework, the TargetFramework msbuild property + --runtime, -r + target runtime, the RuntimeIdentifier msbuild property + --configuration, -c + configuration to use (like Debug), the Configuration msbuild property + --verbose, -v verbose log + --msbuild MSBuild path (default "msbuild") + --dotnetcli Dotnet CLI path (default "dotnet") + --msbuild-host + the Msbuild host, if auto then oldsdk=MSBuild dotnetSdk=DotnetCLI + --help display this list of options. + +``` ## Build