Skip to content

Commit

Permalink
docs(#2): Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
densogiaichned committed Feb 11, 2024
1 parent aa684f9 commit df48f25
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,19 @@ Snappy consists of two parts:
> See [How to manage .NET tools](https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools)
* and the TwinCAT library `snappy`.

### Prerequisites

* [rplc](https://github.com/TcHaxx/rplc) library is installed.
* [Verify - Supported Tool](https://github.com/VerifyTests/DiffEngine?tab=readme-ov-file#supported-tools) is installed.

### TcHaxx.Snappy.CLI

To install the CLI tool execute following command:
```sh
dotnet tool install -g TcHaxx.Snappy.CLI
```
#### Update
To update to the latest verson from [Nuget](https://www.nuget.org/packages/TcHaxx.Snappy.CLI/), run:
To update to the latest version from [Nuget](https://www.nuget.org/packages/TcHaxx.Snappy.CLI/), run:
```sh
dotnet tool update -g TcHaxx.Snappy.CLI
```
Expand All @@ -37,7 +42,7 @@ dotnet tool uninstall -g TcHaxx.Snappy.CLI
```

### snappy.library
Download latest [releases](https://github.com/TcHaxx/snappy/releases), either `snappy.libary` and/or `snappy.compiled-library` and [install](https://infosys.beckhoff.com/english.php?content=../content/1033/tc3_plc_intro/4218300427.html).
Download latest [releases](https://github.com/TcHaxx/snappy/releases), either `snappy.library` and/or `snappy.compiled-library` and [install](https://infosys.beckhoff.com/english.php?content=../content/1033/tc3_plc_intro/4218300427.html).

## Usage
Before any tests are being run, `TcHaxx.Snappy.CLI` hast to be started, prior.
Expand Down

0 comments on commit df48f25

Please sign in to comment.