Commit a0731ec9 authored by scmalte's avatar scmalte

Updated README

parent 3a4a7e77
...@@ -20,6 +20,10 @@ Argument `--upgrade` (re)installs the package, even if the version number hasn't ...@@ -20,6 +20,10 @@ Argument `--upgrade` (re)installs the package, even if the version number hasn't
1. Obtain and prepare data, see `preprocessing/README.md`. 1. Obtain and prepare data, see `preprocessing/README.md`.
**NOTE:** Files `details.json` (see `preprocessing/README.md`) are currently not used.
1. If you want to include additional submissions, e.g. a master solution, create a separate user directory per additional submission, and place the submission code there. E.g. create `~/moss_ex1/ex1/00-000-001/main.cpp`, where user `00-000-001` does not exist otherwise. Corresponding `details.json` files are currently not needed, since not used anyway.
1. Open a shell one level above the directory that contains the user submissions, i.e. the `<user>` directories from `preprocessing/README.md`. E.g. if you have `~/moss_ex1/ex1/<user>`, then `cd ~/moss_ex1`. Afterwards, run `mu-init` to create a directory (`_static`) with files necessary for the next steps (e.g. for the final HTML report). 1. Open a shell one level above the directory that contains the user submissions, i.e. the `<user>` directories from `preprocessing/README.md`. E.g. if you have `~/moss_ex1/ex1/<user>`, then `cd ~/moss_ex1`. Afterwards, run `mu-init` to create a directory (`_static`) with files necessary for the next steps (e.g. for the final HTML report).
1. Run `mu-moss --help` for options that can/must be configured. Afterwards, run `mu-moss` as desired, e.g. `mu-moss -u 1234 -n 300 "./ex1/*/main.cpp"`. 1. Run `mu-moss --help` for options that can/must be configured. Afterwards, run `mu-moss` as desired, e.g. `mu-moss -u 1234 -n 300 "./ex1/*/main.cpp"`.
...@@ -40,7 +44,7 @@ Argument `--upgrade` (re)installs the package, even if the version number hasn't ...@@ -40,7 +44,7 @@ Argument `--upgrade` (re)installs the package, even if the version number hasn't
1. Run `mu-aggr`. 1. Run `mu-aggr`.
**NOTE:** `mu-aggr` is not yet *fully* configurable and expects `mu-cluster` to have used its default file and directory names! Run `mu-aggr --help` for options that can already be configured. **NOTE:** `mu-aggr` is not yet *fully* configurable and expects `mu-cluster` to have used its default file and directory names! Run `mu-aggr --help` for options that must/can already be configured.
`mu-aggr` combines the cluster data with exports from eDoz and Code Expert, and generates a cluster report as an HTML file. `mu-aggr` combines the cluster data with exports from eDoz and Code Expert, and generates a cluster report as an HTML file.
......
Markdown is supported
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