diff --git a/README.md b/README.md index fa70a3e..5a0fe80 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,9 @@ A definition of a Gonito challenge should be put in a separate directory. Such a directory should 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 the ones accepted by `geval` binary (see below), usually just a metric is specified here (e.g. `--metric BLEU`), also non-default diff --git a/src/GEval/CreateChallenge.hs b/src/GEval/CreateChallenge.hs index 0d49c77..13afe19 100644 --- a/src/GEval/CreateChallenge.hs +++ b/src/GEval/CreateChallenge.hs @@ -42,8 +42,10 @@ createFile filePath contents = do readmeMDContents :: Metric -> String -> String 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 the description of your challenge. @@ -64,8 +66,10 @@ Directory structure |] 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 orbital period, orbital eccentricity and the number of its moons). Replace it with