Skip to content

Initial README

Nick Bennett edited this page Jan 26, 2020 · 1 revision

This wiki page is for the initial README. It follows the basic format of announcing the project, and providing links to help other get started. As the project progresses, the README will fill out to be more detailed for future users.

Wiki's should describe what issue one sought to solve, how they solved it, references to what resources and tutorial's used, and pictures of the intended outcome.

Making a README for a github page is as simple as clicking the "Add README" button, or making a file in the root and naming it README. Github offers a markdown service that accepts some HTML. A quick guide is here -> https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

Testing out READMEs on Github is very simple. All one needs to do is preview their code, and they will see the markdown and HTML displayed as it would as a page.

Clone this wiki locally