filipg/geval
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improve README

Browse Source
This commit is contained in:
Filip Gralinski 2022-01-15 15:21:19 +01:00
parent 3ef3416082
commit 4862233cfb
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -780,8 +780,12 @@ Now GEval will work as follows:
### Directory structure of a Gonito challenge ### Directory structure of a Gonito challenge
A definition of a [Gonito](https://gonito.net) challenge should be put in a separate A definition of a [Gonito](https://gonito.net) challenge should be put in a separate
directory. Such a directory should directory. Such a directory should have the structure as given below.
have the following structure:
You don't have to create this structure manually, use `geval --init
...` option to generate a challenge skeleton (see next section).
Standard GEval/Gonito challenge structure:
* `README.md` — description of a challenge in Markdown, the first header * `README.md` — description of a challenge in Markdown, the first header
will be used as the challenge title, the first paragraph — as its short will be used as the challenge title, the first paragraph — as its short
@ -846,7 +850,7 @@ basic facts about Makefiles:
shell commands shell commands
* `$@` is the (first) target, whereas `$<` — the first dependency * `$@` is the (first) target, whereas `$<` — the first dependency
* the indentation should be done with **TABs, not spaces**! (see the * the indentation should be done with **TABs, not spaces**! (see the
[file with TABs](misc/challenge-preparation-example/Makefile) [file with TABs](misc/challenge-preparation-example/Makefile))
Also don't forget to compress aggressively large files (e.g. Also don't forget to compress aggressively large files (e.g.
`train/in.tsv` and `train/expected.tsv`), the xz compressor is a good `train/in.tsv` and `train/expected.tsv`), the xz compressor is a good