From 7bfb6e7cbdc8444041ecc338d625bac60014a630 Mon Sep 17 00:00:00 2001 From: damithc Date: Sat, 17 Jul 2021 16:49:07 +0800 Subject: [PATCH] README.md: Tweak template text * Let's replace 'Feature 1' with 'Feature-ABC' reason: some students kept the 'Feature 1' in the final UG. * Let's tweak the template for features and usage reasons: to fix grammar, to distinguish between output and outcome --- docs/README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/README.md b/docs/README.md index fd44069597..8077118ebe 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,14 +2,19 @@ ## Features -### Feature 1 -Description of feature. +### Feature-ABC + +Description of the feature. + +### Feature-XYZ + +Description of the feature. ## Usage ### `Keyword` - Describe action -Describe action and its outcome. +Describe the action and its outcome. Example of usage: @@ -17,4 +22,8 @@ Example of usage: Expected outcome: -`outcome` +Description of the outcome. + +``` +expected output +```