Skip to content

Commit 2ebc9e5

Browse files
authored
Remove info from readme (#2)
1 parent 669e930 commit 2ebc9e5

File tree

1 file changed

+1
-31
lines changed

1 file changed

+1
-31
lines changed

README.md

Lines changed: 1 addition & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,4 @@
22

33
This is a python module and script that can be used to check homeworks.
44

5-
6-
## How to use it ##
7-
One can specify the expected results in the form of a `yaml` file specifying
8-
excercises and specific tests for them, then this file is fed into the
9-
[`check_homework.py`](ipb_homework_checker/check_homework.py) script. The
10-
result is a markdown file with a table of results and a list of encountered
11-
errors.
12-
13-
To set up a new job script, follow the [`schema.yml`](schema/schema.yml) file.
14-
The schema file is automatically generated whenever you run the tests of this
15-
project, and your script should follow the guides defined in that schema file.
16-
For an example job script, see an example from the tests of this project:
17-
[`example_job.yml`](ipb_homework_checker/tests/data/homework/example_job.yml).
18-
19-
If you want to see a project that uses this checker, feel free to poke around
20-
[homework-solutions-repo][solutions] project. If you have no access, ask me or
21-
Cyrill for it.
22-
23-
## Prerequesits ##
24-
We need `ruamel.yaml` and `schema` libraries to run this code. Install them
25-
with:
26-
```
27-
sudo pip3 install ruamel.yaml schema
28-
```
29-
30-
## Start digging ##
31-
If you want to change anything, start from
32-
[`check_homework.py`](ipb_homework_checker/check_homework.py) script and
33-
dig from there.
34-
35-
[solutions]: https://gitlab.igg.uni-bonn.de/teaching/homework-solutions-repo
5+
To be completed later

0 commit comments

Comments
 (0)