README.md

General Information

Contributors

Name	Email	GitHub Account
Ryan Rion	ryan@hashbang.sh	ChickenNuggers

Project Information

In this section, you should list languages and other information about the project, such as compatible frameworks and if there are optional components you can add in to the software.

You should also describe, in short, what the software is meant to do, and possibly include why you wrote the software. Keep this section no longer than it needs to be.

Dependencies

List dependencies in the following format:

• [dependency](url) (optional|development)

Getting Started

Installing Dependencies with Project-Compatible Package Manager

Describe some basic flags to help make the package manager more compatible and include a description of some easy-to-run commands to install all of the software; however, do not include a shell script file which installs the software for the user.

$ luarocks install cqueues
$ luarocks install luafilesystem
$ luarocks install moonscript # Optional

Further Installation Instructions

If your project has any additional add-ons, such as modules or plugins, you should use this section to describe how to install them. It should be simple and no longer than about a paragraph in length.

Installing Submodules via...

If your addons can be installed via another source, you should use this section to describe how to do just that. This section COULD - but isn't required to - include a shell script section.

Further Information

Sometimes, the user might need more information about the project than just the installation instructions; for this, you can use the lower area to add in any information you want. Just follow some basic rules when doing this:

1. Keep it concise - You shouldn't use more than a paragraph.
2. Keep it logical - Users should be able to clearly understand you.
3. Keep it fresh - The document as a whole should be varied in structure but not too varied.