dishpit / github-template

A high-quality template of a github repository structure.

Github Template

Github Template is an example layout of what I believe to be a good github repository structure. As always, your personal use-case and your mileage may vary - what works for me doesn't always work for everybody else, so please fine-tune it to fit your needs. This is meant to be used as an example.

All of the data provided (such as dependencies and requirements) are for the sake of example, and are not meant to be actual guidelines or specifications. Again, tailor it to fit your needs.

Supported Platforms

Please refer to the Requirements document for support matrices.

Compiling/Development

Dependencies

Required

• A computer
• cargo
• rustc

Getting started

Clone the project, then run npm run dev or cargo run or whatever your run command is!

Compiling

Ensure you have rustc and cargo installed, then run cargo build --release.

Support and Contributions

If you think you have found a bug or have a feature request, use our issue tracker. Before opening a new issue, please search to see if your problem has already been reported. Try to be as detailed as possible in your issue reports.

If you are interested in contributing fixes or features to FooBar, please read our contributors guide first.

Source Code

Getting started with FooBar couldn't be easier. Make sure you have Gumbies installed.

• Clone the source: git clone https://github.com/Dishpit/Github-Template.git
• Click our heels thrice
• Spin around in a circle
• Build