https://github.com/sutac/gameoflife
A simple implementation of Conway's Game of Life.
https://github.com/sutac/gameoflife
canvas2d gameoflife javascript jsdoc jsdoc2md
Last synced: over 1 year ago
JSON representation
A simple implementation of Conway's Game of Life.
- Host: GitHub
- URL: https://github.com/sutac/gameoflife
- Owner: sutaC
- Created: 2024-03-27T18:20:09.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-30T10:38:20.000Z (over 1 year ago)
- Last Synced: 2025-01-30T11:29:26.552Z (over 1 year ago)
- Topics: canvas2d, gameoflife, javascript, jsdoc, jsdoc2md
- Language: JavaScript
- Homepage: https://sutac.github.io/GameOfLife/
- Size: 45.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Game of Life
A simple implementation of [Conway's Game of Life](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life).
## Technologies
- JavaScript
- JSDoc
## How to start?
You only need to serve static files from `src/` directory. For example using command:
```bash
npx serve src
```
## Documentation
Documentation is located in [DOCS.md](./DOCS.md) file in root directory of a project.
It is generated with [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown) package.
For generating documentation uou can run [document](./document) shell comand if running linux with bash.
Alternativelym, command for generating documentation is:
```bash
jsdoc2md ./src/**/*.js > DOCS.md
```
(Make sure you are not using PowerShell with this command, becouse it causes encoding issues.)