Skip to content

Commit bd5b6c6

Browse files
committed
chore: update README and add issue templates
1 parent e2b0052 commit bd5b6c6

File tree

5 files changed

+97
-13
lines changed

5 files changed

+97
-13
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.
+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

CONTRIBUTING.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
As I would like to submit this project to the Congressional App
2+
Challenge, I unfortunately cannot accept contributions until Monday,
3+
October 19th, 2020 at the earliest. Kindly hold any issues and pull
4+
requests until then.

README.md

+35-13
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,35 @@
1-
# Human Computer Simulator
2-
*Human Computer Simulator* is a game where you get to become your
3-
favorite algorithm and or data structure.
4-
5-
# Screenshots
6-
![Level Select](assets/levels.png)
7-
8-
# Download
9-
This software is in an alpha stage of development and I do not plan on
10-
releasing ready-to-run builds until a stable v1.0 release. However, it
11-
is very easy to run it yourself. Just grab the free and open source
12-
[Godot game engine](https://godotengine.org), import the `project.godot`
13-
file, and hit the play button.
1+
<br />
2+
<p align="center">
3+
<img src="assets/icon.png" alt="Logo" width="80" height="80">
4+
5+
<h1 align="center">Human Computer Simulator</h1>
6+
7+
<p align="center">
8+
A game where you get to become your favorite algorithm or data structure!
9+
<br />
10+
<a href="https://github.com/DanielZTing/human-computer-simulator/issues/new?template=bug_report.md">Report Bug</a>
11+
·
12+
<a href="https://github.com/DanielZTing/human-computer-simulator/issues/new?template=feature_request.md">Request Feature</a>
13+
</p>
14+
</p>
15+
16+
## Table of Contents
17+
18+
* [About the Project](#about-the-project)
19+
* [Getting Started](#getting-started)
20+
21+
## About The Project
22+
23+
![Level select screen](assets/levels.png)
24+
25+
You may have come across the famous [15 Sorting Algorithms in 6 Minutes](https://www.youtube.com/watch?v=kPRA0W1kECg) video by [Timo Bingoman](https://github.com/bingmann) at some point in your computer science career. There is currently no shortage of neat visualizations of all kinds of algorithms, but what if you could become the algorithm itself?
26+
27+
In *Human Computer Simulator*, you control an algorithm operating on some data structure. Right now, the game is limited to sorting arrays. The end vision is to have a library of interactive, playable levels on anything from a search on a binary tree to Dijkstra's shortest path on a graph.
28+
29+
It's written using the Godot game engine and licensed with [almost no restrictions](LICENSE.txt). Use it to make a lecture a bit more interesting, review for an assignment, or just kill time. Hope you enjoy.
30+
31+
## Getting Started
32+
33+
This software is in an alpha stage of development and I do not plan on releasing ready-to-run builds until a stable v1.0 release. However, it is very easy to run and hack the source code yourself. Just grab the lightweight free and open source [Godot game engine](https://godotengine.org/download), import the `project.godot` file, and hit the play button.
34+
35+
A demo version (large download warning: ~20 MB) is available on this repository's [Github Pages](https://danielzting.github.io/human-computer-simulator). It requires a desktop browser with support for WebAssembly and WebGL; mobile is not currently supported. Since this is still in alpha, some things might be dumb, make no sense whatsoever, or just break outright. I welcome any feedback you may have.

assets/levels.png

-61 KB
Loading

0 commit comments

Comments
 (0)