maxmustermann/dotnet-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update README

Browse source
This commit is contained in:
Rich Lander 2020-08-21 11:14:10 -07:00
parent f4ddfe4f59
commit 4ed5c02a61
3 changed files with 22 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
samples/dotnetsay/README.md
View file

@ -1,12 +1,12 @@
# dotnetsay .NET Core Global Tools Sample
# dotnetsay .NET Tool Sample
This sample demonstrates how to use and create .NET Core Global Tools. It works on Windows, macOS and Linux.
This sample demonstrates how to use and create .NET Tools. It works on Windows, macOS and Linux.
You must have [.NET Core 2.1](https://dotnet.microsoft.com/download/dotnet-core/2.1) or higher installed.
You must have the .NET SDK installed, [.NET Core 2.1](https://dotnet.microsoft.com/download/dotnet-core/2.1) or higher.
## Try the pre-built `dotnetsay` Global Tool
## Installation
You can quickly install and try the [dotnetsay global tool from nuget.org](https://www.nuget.org/packages/dotnetsay/) using the following commands.
You can quickly install and try the [dotnetsay](https://www.nuget.org/packages/dotnetsay/):
```console
dotnet tool install -g dotnetsay
@ -21,16 +21,6 @@ You can uninstall the tool using the following command.
dotnet tool uninstall -g dotnetsay
```
## Getting the sample
The easiest way to get the sample is by cloning the samples repository with [git](https://git-scm.com/downloads), using the following instructions.
```console
git clone https://github.com/dotnet/core/
```
You can also [download the repository as a zip](https://github.com/dotnet/core/archive/master.zip).
## Build the Tool from source
You can build and package the tool using the following commands. The instructions assume that you are in the root of the repository.

3
samples/dotnetsay/dotnetsay.csproj
View file

@ -1,13 +1,12 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<Description>A simple .NET Core tool called "dotnetsay".</Description>
<OutputType>Exe</OutputType>
<TargetFramework>netcoreapp2.1</TargetFramework>
<RollForward>LatestMajor</RollForward>
<Description>A simple .NET Core global tool called "dotnetsay".</Description>
<VersionPrefix>2.1.5</VersionPrefix>
<Authors>.NET Team</Authors>
<Product>dotnetsay</Product>
<License>MIT</License>
<PublishRepositoryUrl>true</PublishRepositoryUrl>
<DebugType>embedded</DebugType>

19
samples/versioninfo/README.md
View file

@ -1,14 +1,23 @@
# dotnet-versioninfo tool
Produces information about your .NET, OS and hardware environment. It is also a demonstration of the APIs you can use to get this information for your own uses. This information is likely useful for logging.
`dotnet-versioninfo` prints information about your .NET, OS and hardware environment. It is also a demonstration of the APIs you can use to get this information for your own uses. This information is likely useful for logging.
## Installation
You can quickly install and try the [dotnet-versioninfo](https://www.nuget.org/packages/dotnet-versioninfo/):
```console
dotnet install -g dotnet-versioninfo
dotnet tool install -g dotnet-versioninfo
dotnet-versioninfo
```
[dotnet-versioninfo package](https://www.nuget.org/packages/dotnetsay/)
> Note: You may need to open a new command/terminal window the first time you install a tool.
You can uninstall the tool using the following command.
```console
dotnet tool uninstall -g dotnet-versioninfo
```
## Usage
@ -26,3 +35,7 @@ OSVersion: Unix 19.6.0.0
OSArchitecture: X64
ProcessorCount: 8
```
## More information
The [dotnetsay tool sample](../dotnetsay/README.md) includes more information on .NET tools.