Example ReadMe file.

README.md

ReadMe Template

Optional Image Here

Table of Contents

1. Introduction
2. Prerequisites
3. Setup
4. Authors
5. License
6. Acknowledgments

Introduction

Describe your project here. Modify this file tree example to mirror your project. Directory structure:

example.com/
├── app.js
├── bin/
│   └── www
├── node_modules/
│   └── (╯°□°)╯︵ ┻━┻
├── package.json
├── public/
│   ├── images/
│   └── stylesheets/
│       └── style.css
└── views/
    ├── error.ejs
    └── index.ejs

Feel free to use code snippets like the follwing throughout your ReadMe.

var className = 'CS50xMiami'
var cohort = "6th"
var name = "Dylan"

alert("I am " + name + " and this is " + className + "'s " + chohort = " cohort!"

Prerequisites

List all software or dependencies needed to install the program

List any specific or standard requirements of the tools you used to implement your project. Does your project have any specific requirements to run on the Web or on any PC?

Setup

Step by step, preferably numbered, list of instructions on how to install and run your program

Authors

• Your Name - Contact

License

Optional. Read more here: https://en.wikipedia.org/wiki/Software_license. One popular license for open source projects is the MIT license, which can read and adapted from here: https://opensource.org/licenses/MIT.

Acknowledgments

Optional. If you recieved assistance from anyone, it's usually nice to say thanks in a place like this.