mirror of
https://github.com/kylelobo/The-Documentation-Compendium.git
synced 2025-09-08 04:00:38 +02:00
Create Minimal.md
This commit is contained in:
41
README Templates/Minimal.md
Normal file
41
README Templates/Minimal.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# Table of Contents
|
||||
+ [About](#about)
|
||||
+ [Getting Started](#getting_started)
|
||||
+ [Usage](#usage)
|
||||
+ [Contributing](../CONTRIBUTING.md)
|
||||
|
||||
## About <a name = "about"></a>
|
||||
Write about 1-2 paragraphs describing the purpose of your project.
|
||||
|
||||
## Getting Started <a name = "getting_started"></a>
|
||||
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
What things you need to install the software and how to install them.
|
||||
|
||||
```
|
||||
Give examples
|
||||
```
|
||||
|
||||
### Installing
|
||||
|
||||
A step by step series of examples that tell you how to get a development env running.
|
||||
|
||||
Say what the step will be
|
||||
|
||||
```
|
||||
Give the example
|
||||
```
|
||||
|
||||
And repeat
|
||||
|
||||
```
|
||||
until finished
|
||||
```
|
||||
|
||||
End with an example of getting some data out of the system or using it for a little demo.
|
||||
|
||||
## Usage <a name = "usage"></a>
|
||||
|
||||
Add notes about how to use the system.
|
Reference in New Issue
Block a user