project_title!

project_description by Fathom 7 Digital Studios!
Explore the Docs »

View Steam Page · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Description

project_description

Key Features:

Built With

• Github

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Source Control Tool (GitKraken preferred)
• Script Editor (VSCode preferred)
• Windows / Mac OS

Installation

1. Clone the repo

   git clone https://github.com/Truly-Integrated-Computing/repo_name.git

2. Initialize GitLFS and Verify

   git lfs install

3. Initialize GitFlow using:

   Default Branch: main
   Develop Branch: dev
   Feature Prefix: feature/
   Release Prefix: release/
   Hotfix Prefix: hotfix/
   Version Tag Prefix: v

Usage

Follows standard F7 Engine Style usage guidelines.

For examples, please refer to the F7 Style Guide: F7 Style Guide

Roadmap

See the Asana Board for a list of milestones, features, and known issues).

Branch Workflow

Fathom 7 Digital Studios utilizes the GitFlow methodology for branch workflows. The basic workflow is as follows:

1. Clone the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request using F7 PR Template. See F7 Style Guide for Template.

License

Private Distribution, Fathom 7 Digital Studios: 2021.
See LICENSE.md for more information.

Contact

John Murwin - @JohnMurwin - [email protected]

Project Website: www.project_title.com

Project Link: https://github.com/Truly-Integrated-Computing/repo_name

Acknowledgements

• @Othneildrew
• @stevemao
• @Allar