Github readme Generator

Type your information in each of the sections. You can click and drag the sections to reorder them or leave them blank to exclude them.

You can still use Markdown syntax. Some are listed below for convenience:

  • ``` At the start and end of text to highlight code. Add the backticks on a new line for a code block, if not it will be inline
  • # or any number of hashes for headings. The project title is automatically # and all other sections are ##
  • - A dash adds a list item. Remember to add a space between the dash and text
  • ![](relative location) Replace the relative location with the location of the image or link. Relative to the readme file location in your folder structure

Generated Readme
Project Title

What is your project called?

Description

What is your project?

Table of contents

Displays the table of contents. The order is exactly the same that appears here

Installation

How do you install dependencies or setup your project?

Tests

What do you use to run tests and how do you use your tests?

How to use the project

Any instructions on how to use the project

How to contribute

How do you contribute to this repo

credits

Anyone else you would like to credit? As well as websites/repos you got inspiration from?

License

What licence does your project use?