Skip to content

Commit 286f807

Browse files
committed
chore: add docs
1 parent ed61b07 commit 286f807

File tree

5 files changed

+42
-0
lines changed

5 files changed

+42
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[![CI](https://github.com/ssouthcity/fear_factory/actions/workflows/ci.yaml/badge.svg)](https://github.com/ssouthcity/fear_factory/actions/workflows/ci.yaml)
2+
[![Release](https://github.com/ssouthcity/fear_factory/actions/workflows/release.yaml/badge.svg)](https://github.com/ssouthcity/fear_factory/actions/workflows/release.yaml)
3+
[![Version](https://img.shields.io/github/v/release/ssouthcity/fear_factory)](https://github.com/ssouthcity/fear_factory/releases)
4+
5+
# Fear Factory
6+
7+
Fear Factory is a factory building simulator with a horror twist.
8+
9+
Instead of managing ores and machinery, you play an alchemist with foul intentions, and the penultimate goal of crafting a philosophers stone!
10+
11+
![Gameplay Preview](https://picsum.photos/seed/picsum/1920/1080)
12+
TODO: Add gameplay preview to README
13+
14+
Consult the [docs](docs/index.md) to learn more about the project.

docs/design/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Design
2+
3+
This section defines the gameplay design of the game.
4+
5+
## Index
6+
7+
* [Terminology](./terminology.md)
8+
9+
## Core Gameplay Loop
10+
11+
The goal is to manage items and automate processes until the final stage item can be created. The challenge...

docs/design/terminology.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Terminology
2+
3+
List of game specific terms and their definition/scope.
4+
5+
| Term | Definition |
6+
| --- | --- |
7+
| Item | Any object that can be collected by the player or other entities |
8+
| Recipe | An instruction that takes one or more items as input and produces one or more items as output |

docs/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Documentation
2+
3+
This is the root of the documentation. Use the links below to navigate:
4+
5+
* [Design](./design/index.md)
6+
* [Workflows](./workflows.md)

docs/workflows.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Workflows
2+
3+
Developer workflows such as CI, deployments and local development.

0 commit comments

Comments
 (0)