Skip to content

Commit

Permalink
Update and rename template-tutorial.adoc to tutorial.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mamonraab authored Oct 3, 2020
1 parent 237efb4 commit fba7652
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 46 deletions.
46 changes: 0 additions & 46 deletions template-tutorial.adoc

This file was deleted.

62 changes: 62 additions & 0 deletions tutorial.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# fire-detection-in-video-with-pytroch

<!-- Copy this Template. -->
<!-- Describe the title of your article by replacing "How-to Template" with the page name you want to publish to. -->
# How-to template

## Overview

Summarise what this how-to article is about in a sentence or two.
How-to articles primarily include tasks, and answer the question "how do I do it?".
Readers who are reading tasks are engaging in a learning behavior.

Readers should already have read a concept about the topic in an About article.
Ensure you link to the relevant About article here.


**Keywords:** Optionally add comma-separated keywords.

## Before you start
<!-- Delete this section if your readers can dive straight into the lesson without requiring any prerequisite knowledge. -->
Make sure you meet the following prerequisites before starting the how-to steps:

* Prerequisite one
* Prerequisite two
* etc

Include other important information here too, such as known issues or bugs.

## Step-by-step guide

### Step 1: Optional: Title for step - image or screenshot

<!-- When an image, such as a screenshot, is quicker to interpret than descriptive text, put the screenshot first, otherwise lead with the text. -->

![alt text](https://upload.wikimedia.org/wikipedia/commons/3/35/Tux.svg "Image title which describes image.")

Brief instructions explaining how to interpret the image.

### Step 2: Optional: title for step - ordered list

Lead-in sentence for an ordered list:

1. Substep A
1. Substep B
1. Substep C

### Step 3: Optional: title for step - code snippet

Lead-in sentence explaining the code snippet. For example:

Run the `apt` command to install the Asciidoctor package and check the version.

```
$ sudo apt install asciidoctor
$ asciidoctor --version
Asciidoctor 1.5.6.2 [https://asciidoctor.org]
```

### Step 4: Optional: title for step - Conclusion

Provide a summary of the steps completed and explain what the user has achieved by following them. You can also include links to related articles that may help the reader reinforce concepts discussed in this how-to article.

0 comments on commit fba7652

Please sign in to comment.