Skip to content

Commit

Permalink
README.md: Tweak template text
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
damithc committed Jul 17, 2021
1 parent eabcfca commit 7bfb6e7
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,28 @@

## 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:

`keyword (optional arguments)`

Expected outcome:

`outcome`
Description of the outcome.

```
expected output
```

0 comments on commit 7bfb6e7

Please sign in to comment.