diff --git a/srp_analysis/README.md b/srp_analysis/README.md new file mode 100644 index 0000000000000000000000000000000000000000..901447cc991d728744cd7b00cc86aeae84ce5cfd --- /dev/null +++ b/srp_analysis/README.md @@ -0,0 +1,51 @@ +# srp analysis + +This is a command line interface analysis tool that analyses the response time and overall schedulability. + +## Usage + +This is a cli tool that will run an example if no input file is given, see the Reading input from file section bellow for help or run the following for help. +``` +srp_analysis --help +``` +or +``` +srp_analysis -h +``` + +The output can be written to a file(see the "Writhing output to file" section bellow for help). + +There is a `-j` or `--json` flag to output the data in json format. + +### Reading input from file + +Reading the input from file can be done by running one of the following commands. +``` +sro_analysis -i <FILE PATH> +``` +or +``` +sro_analysis --in-file <FILE PATH> +``` + +where <FILE PATH> is the relative path to input json file. + +### Writhing output to file + +Writhing the output to file can be done by running one of the following commands. +``` +sro_analysis -o <FILE PATH> +``` +or +``` +sro_analysis --out-file <FILE PATH> +``` +where <FILE PATH> is the relative path to output file. + +### Example + +An example of using the file `analysis.json` as input and outputting the result to a new file `analysed.txt`. +``` +srp_analysis -i analysis.json -o analysed.txt +``` +