Commit 296f27f2 authored by scmalte's avatar scmalte

Updated README

parent 1087b4d3
......@@ -22,7 +22,7 @@ Argument `--upgrade` (re)installs the package, even if the version number hasn't
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 arguments 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"`.
`mu-moss` connects to the Moss service, uploads submissions and downloads the generated report. This may take a while, and will probably not work for large `-n` values (3000 worked for me, 10,000 didn't).
......@@ -34,7 +34,7 @@ Argument `--upgrade` (re)installs the package, even if the version number hasn't
1. Run `mu-cluster`.
**NOTE:** `mu-cluster` is not yet configurable and expects `mu-revise` to have used its default file and directory names!
**NOTE:** `mu-cluster` is not yet *fully* configurable and expects `mu-revise` to have used its default file and directory names! Run `mu-cluster --help` for options that can already be configured.
`mu-cluster` computes clusters of plagiarism, creates as DOT and SVG files (by running GraphViz, which *must be in the path*), and creates a summarising CSV file.
......@@ -44,6 +44,10 @@ Argument `--upgrade` (re)installs the package, even if the version number hasn't
`mu-aggr` combines the cluster data with exports from eDoz and Code Expert, and generates a cluster report as an HTML file.
* Code Expert export: `My Courses -> Students (Student Overview) -> Export to CSV` and save `./cx_students.csv`
* eDoz exports: **TODO:** `mu-aggr` is currently not reusable, since eDoz export files are hardcoded. Must make them configurable!
## Python Package Tutorials
I've used the following tutorials to get started with developing a Python package:
......
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