Add README.md
This commit is contained in:
parent
5d6969642a
commit
e991ccd383
71
README.md
Normal file
71
README.md
Normal file
@ -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 -->
|
||||||
|
[](https://git.zakscode.com/ztimson/Cell/tags)
|
||||||
|
[](https://git.zakscode.com/ztimson/Cell/pulls)
|
||||||
|
[](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
|
||||||
|
[](https://javascript.com/)
|
||||||
|
[](https://nodejs.org/)
|
||||||
|
[](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.
|
Loading…
x
Reference in New Issue
Block a user