Skip to content

Commit

Permalink
docs/README.md: Tweak document template
Browse files Browse the repository at this point in the history
Let's tweak the docs/README.md (which is used as the user guide)
to fit Duke better. Specifically,

1. mention product name in the title
2. mention adding a product screenshot and a product intro
3. tweak the flow to describe feature-by-feature
  • Loading branch information
damithc committed Jan 7, 2024
1 parent 3b83789 commit 55f9f9f
Showing 1 changed file with 17 additions and 16 deletions.
33 changes: 17 additions & 16 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,30 @@
# User Guide
# Duke User Guide

## Features
// Update the title above to match the actual product name

### Feature-ABC
// Product screenshot goes here

Description of the feature.
// Product intro goes here

### Feature-XYZ
## Adding deadlines

Description of the feature.
// Describe the action and its outcome.

## Usage
// Give examples of usage

### `Keyword` - Describe action
Example: `keyword (optional arguments)`

Describe the action and its outcome.
// A description of the expected outcome goes here

Example of usage:
```
expected output
```

`keyword (optional arguments)`
## Feature ABC

Expected outcome:
// Feature details

Description of the outcome.

```
expected output
```
## Feature XYZ

// Feature details

0 comments on commit 55f9f9f

Please sign in to comment.