From 79932e0f59b2cfc1e402ae48711ed46afa147c24 Mon Sep 17 00:00:00 2001 From: bleeptrack Date: Mon, 1 Mar 2021 11:12:58 +0100 Subject: [PATCH] cli hints in readme --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e1a79bf..cfbb06a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # Oh My Git! + **Oh My Git!** is an open-source game about learning Git! @@ -35,6 +36,12 @@ This text will be shown when the level starts. It describes the task or puzzle the player can solve. +[cli] + +(optional) This text will be shown below the level description in a darker color. + +It should give hints to the player about command line usage and also maybe some neat tricks. + [congrats] This text will be shown after the player has solved the level. @@ -56,7 +63,8 @@ git commit -m "Initial commit" # writing the body of a Bash function. Make the function return 0 if it's # solved, and a non-zero value otherwise. You can use `return`, and also, Bash # functions return the exit code of the last statement, which sometimes allows -# very succinct checks. +# very succinct checks. The comment above the win check will be shown in the game +# as win condition text. # Check whether the file has at least two lines in the latest commit: test "$(git show HEAD:people_who_are_awesome | wc -l)" -ge 2