info/the-documentation-compendium
1
0
Fork 0
mirror of https://github.com/kylelobo/The-Documentation-Compendium.git synced 2025-09-25 04:01:39 +02:00
Code Issues Releases Wiki Activity

Added emojis

Browse Source
This commit is contained in:
Kyle Lobo
2019-06-06 03:50:07 +05:30
committed by GitHub
parent ed94faa02f
commit 8c328a3a2f
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README Templates/Standard.md
View File

@@ -2,6 +2,7 @@
<a href="" rel="noopener">
<img width=200px height=200px src="https://i.imgur.com/6wj0hh6.jpg" alt="Project logo"></a>
</p>
<h3 align="center">Project Title</h3>
<div align="center">
@@ -19,7 +20,7 @@
<br>
</p>
# Table of Contents
# 📝 Table of Contents
+ [About](#about)
+ [Getting Started](#getting_started)
+ [Deployment](#deployment)
@@ -29,10 +30,10 @@
+ [Authors](#authors)
+ [Acknowledgments](#acknowledgement)
## About <a name = "about"></a>
## 🧐 About <a name = "about"></a>
Write about 1-2 paragraphs describing the purpose of your project.
## Getting Started <a name = "getting_started"></a>
## 🏁 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
@@ -61,7 +62,7 @@ until finished
End with an example of getting some data out of the system or using it for a little demo.
## Running the tests <a name = "tests"></a>
## 🔧 Running the tests <a name = "tests"></a>
Explain how to run the automated tests for this system.
@@ -81,23 +82,23 @@ Explain what these tests test and why
Give an example
```
## Deployment <a name = "deployment"></a>
## 🚀 Deployment <a name = "deployment"></a>
Add additional notes about how to deploy this on a live system.
## Built With <a name = "tech_stack"></a>
## ⛏️ Built With <a name = "tech_stack"></a>
+ [MongoDB](https://www.mongodb.com/) - Database
+ [Express](https://expressjs.com/) - Server Framework
+ [VueJs](https://vuejs.org/) - Web Framework
+ [NodeJs](https://nodejs.org/en/) - Server Environment
## Authors <a name = "authors"></a>
## ✍️ Authors <a name = "authors"></a>
+ [@kylelobo](https://github.com/kylelobo) - Idea & Initial work
See also the list of [contributors](https://github.com/kylelobo/The-Documentation-Compendium/contributors) who participated in this project.
## Acknowledgements <a name = "acknowledgement"></a>
## 🎉 Acknowledgements <a name = "acknowledgement"></a>
+ Hat tip to anyone whose code was used
+ Inspiration
+ References