Skip to content

Commit

Permalink
Usage clarified in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
panos1b authored Apr 16, 2024
1 parent 90d493d commit 87a1573
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
## Description
This repository contains the second lab project for the SEIP module. This basic program will produce statistical metrics for a set of integers.
## Usage
#### First Usage:
- First you must clone the project. Navigate to a folder of your choice then run
`git clone https://github.com/panos1b/SEIP-lab`
- Then enter to the project foler
Expand All @@ -12,6 +13,9 @@ This repository contains the second lab project for the SEIP module. This basic
- Finnaly you can run the programm as follows
`docker run stats_analysis --help`
- This will bring up the help. Replace `--help` with your arguments and values
#### Every susequent use:
- Directly run the program via docker image whilst in the correct folder \
`docker run stats_analysis [--min] [--max] [--mode] [--mean] [--median] [integer1 integer2 ...]`
## Examples
#### Using a singular argument
~~~
Expand Down Expand Up @@ -40,7 +44,7 @@ ___
#### Mixing things up is okay!
`docker run stats_analysis --mode 5 --median 6 --max 4 6 --min` \
`docker run stats_analysis --mode --median --max --min 5 6 4 6`
* Both will output:
* **Both** will output:
~~~
> The minimum is: 4
> The maximum is: 6
Expand Down

0 comments on commit 87a1573

Please sign in to comment.