Add README.md

2023-08-14 17:19:27 +00:00 · 2023-08-14 17:19:27 +00:00 · e991ccd383
commit e991ccd383
parent 5d6969642a
1 changed files with 71 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,71 @@
+<!-- Header -->
+<div id="top" align="center">
+  <br />
+  
+  <!-- Logo -->
+  <img src="https://git.zakscode.com/repo-avatars/ff3dc79d3d4c32867dad830d856fb9a7f6abd6f3527837e3d697683e16b314c2" alt="Logo" width="200" height="200">
+
+  <!-- Title -->
+  ### Cell
+  
+  <!-- Description -->
+  Program your own "cell"
+
+  <!-- Repo badges -->
+  [![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/Cell/tags&query=$[0].name)](https://git.zakscode.com/ztimson/Cell/tags)
+  [![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/Cell&query=open_pr_counter)](https://git.zakscode.com/ztimson/Cell/pulls)
+  [![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/Cell&query=open_issues_count)](https://git.zakscode.com/ztimson/Cell/issues)
+
+  <!-- Links -->
+  ---
+  <div>
+    <a href="https://git.zakscode.com/ztimson/template/wiki" target="_blank">Documentation</a>
+    • <a href="https://git.zakscode.com/ztimson/template/releases" target="_blank">Release Notes</a>
+    • <a href="https://git.zakscode.com/ztimson/template/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
+    • <a href="https://git.zakscode.com/ztimson/template/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
+  </div>
+
+  ---
+</div>
+
+## Table of Contents
+- [Cell](#top)
+  - [About](#about)
+    - [Built With](#built-with)
+  - [Setup](#setup)
+    - [Development](#development)
+  - [License](#license)
+
+## About
+Cell is an experimental game concept. It's goal is to create a fun programming game themed around microscopic cells & their evolution.
+
+Players have access to an API in _Javascript_ to program a cell to consume other cells & survive a hostile environment. As the user progresses they will gain access to more of the API allowing their cells to become more complex.
+
+### Built With
+[![JavaScript](https://img.shields.io/badge/JavaScript-000000?style=for-the-badge&logo=javascript)](https://javascript.com/)
+[![Node](https://img.shields.io/badge/Node.js-000000?style=for-the-badge&logo=nodedotjs)](https://nodejs.org/)
+[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/)
+
+## Setup
+
+<details>
+<summary>
+  <h3 id="development" style="display: inline">
+    Development
+  </h3>
+</summary>
+
+#### Prerequisites
+- [Node.js](https://nodejs.org/en/download)
+
+#### Instructions
+1. Install the dependencies: `npm install`
+2. Start the Angular server: `npm run start`
+3. Open [http://localhost:4200](http://localhost:4200)
+
+</details>
+
+## License
+Copyright © 2023 Zakary Timson | All Rights Reserved | Available under MIT Licensing
+
+See the [license](./LICENSE) for more information.