info about title and description

This commit is contained in:
Filip Gralinski 2015-08-27 21:42:28 +02:00 committed by Filip Gralinski
parent 517cef9088
commit e96f16b829
2 changed files with 11 additions and 5 deletions

View File

@ -31,7 +31,9 @@ A definition of a Gonito challenge should be put in a separate
directory. Such a directory should directory. Such a directory should
have the following structure: have the following structure:
* `README.md` — description of a challenge in Markdown * `README.md` — description of a challenge in Markdown, the first header
will be used as the challenge title, the first paragraph — as its short
description
* `config.txt` — simple configuration file with options the same as * `config.txt` — simple configuration file with options the same as
the ones accepted by `geval` binary (see below), usually just a the ones accepted by `geval` binary (see below), usually just a
metric is specified here (e.g. `--metric BLEU`), also non-default metric is specified here (e.g. `--metric BLEU`), also non-default

View File

@ -42,8 +42,10 @@ createFile filePath contents = do
readmeMDContents :: Metric -> String -> String readmeMDContents :: Metric -> String -> String
readmeMDContents BLEU testName = [i| readmeMDContents BLEU testName = [i|
GEval sample machine translation challenge GEval sample machine translation challenge
============================================ ==========================================
Translate from Finnish to Māori.
This is a sample challenge (translating from Finnish to Māori) for Gonito framework. Replace it with This is a sample challenge (translating from Finnish to Māori) for Gonito framework. Replace it with
the description of your challenge. the description of your challenge.
@ -64,8 +66,10 @@ Directory structure
|] |]
readmeMDContents _ testName = [i| readmeMDContents _ testName = [i|
GEval sample challenge GEval sample challenge
======================== ======================
Guess the mass of a planet.
This is a sample challenge for Gonito framework (guessing the mass of a planet using its This is a sample challenge for Gonito framework (guessing the mass of a planet using its
orbital period, orbital eccentricity and the number of its moons). Replace it with orbital period, orbital eccentricity and the number of its moons). Replace it with