romainc75/basic-readme-template

Readme template for simple open-source projects

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: github_username, github_repo, twitter_handle, email

Then you can delete these lines !

About The Project

Here you can describe the project, why you made it and for who you made it, but mostly don't forget to add a screenshot like the image above AND a link to the demo like this : https://NicolasBrondin.github.io/basic-readme-template/

Built With

• 🖊️ Markdown
• 🐙 Github
• 💻 VS Code

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Git

sudo apt-get install git

Installation

1. Clone the repo

git clone https://github.com/NicolasBrondin/basic-readme-template

2. Open VS Code
3. Install Markdown Preview Enhancement plugin
4. Open the README.md file and execute the following command

ctrl+k v

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Contact

Your Name - @twitter_handle - email

Project Link: https://github.com/github_username/github_repo

Acknowledgements

• This readme version is a simplified version of this github repository by Othneildrew