Commit 00c63ec7 authored by Jakub Koudelka's avatar Jakub Koudelka
Browse files

adding examples to README

parent b1813e69
# PV260 Project
Using .NET 6 and NUnit for testing.
## How to run project
Our project has cmd interface which can be used with arguments.
By using --help the help output is printed. this outputs:
```
At least one option from group 'output' (c, console, s, slack) is required.
-o, --old Required. Input old stock file path.
-n, --new Required. Input new stock file path.
-c, --console (Group: output) Send output to console
-s, --slack (Group: output) Send output to inserted slack uri
--help Display this help screen.
--version Display version information.
```
## Examples of running project
Examples can be run thanks to our launchSettings profiles or manully.
We have test data in our folder so project can be run on those data.
Example arguments for propper use with console
```-o .\..\..\..\..\Data\march.csv -n .\..\..\..\..\Data\april.csv -c```
or slack
```-o .\..\..\..\..\Data\march.csv -n .\..\..\..\..\Data\april.csv -s https://hooks.slack.com/services/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```
We also include some inproper usage where path or file name doesnt exist
```
wrong path:
-o .\..\..\..\..\Daa\march.csv -n .\..\..\..\..\Data\april.csv -c
-o .\..\..\..\..\Data\march.csv -n .\..\..\..\..\Daa\april.csv -c
-o .\..\..\..\..\Dta\march.csv -n .\..\..\..\..\Data\april.csv -s https://hooks.slack.com/services/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
```
```
wrong file:
-o .\..\..\..\..\Data\march.csv -n .\..\..\..\..\Data\apil.csv -c
-o .\..\..\..\..\Data\mach.csv -n .\..\..\..\..\Data\april.csv -c
-o .\..\..\..\..\Data\mach.csv -n .\..\..\..\..\Data\april.csv -s https://hooks.slack.com/services/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
```
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment