From c3d7c89a7ea6021de14e2fde0139c580d218504e Mon Sep 17 00:00:00 2001 From: Marco Perone Date: Mon, 20 Mar 2023 10:56:15 +0100 Subject: [PATCH] provide some basic instructions to play the hobbit game --- examples/Crem/Example/TheHobbit.hs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/examples/Crem/Example/TheHobbit.hs b/examples/Crem/Example/TheHobbit.hs index e0f4090..b41349e 100644 --- a/examples/Crem/Example/TheHobbit.hs +++ b/examples/Crem/Example/TheHobbit.hs @@ -10,6 +10,12 @@ -- https://downloads.haskell.org/ghc/latest/docs/users_guide/using-warnings.html#ghc-flag--Wunused-type-patterns {-# OPTIONS_GHC -Wno-unused-type-patterns #-} +-- | This is a small adventure game based on [The Hobbit](https://en.wikipedia.org/wiki/The_Hobbit_(1982_video_game)) +-- video game. You can play it by running @cabal run hobbit-game@. It will ask +-- you to enter commands. You need to use the precise names of the constructors +-- for the `HobbitCommand` data type, like `GoEast`, `GoWest` and so on. +-- Moreover, with the @cabal run hobbit-map@ command, you could generate, from +-- the definition of the state machine, a diagram with the map of the game. module Crem.Example.TheHobbit where import Crem.BaseMachine