diff options
Diffstat (limited to 'life2/game/README.md')
| -rw-r--r-- | life2/game/README.md | 41 |
1 files changed, 0 insertions, 41 deletions
diff --git a/life2/game/README.md b/life2/game/README.md deleted file mode 100644 index ae322b8..0000000 --- a/life2/game/README.md +++ /dev/null @@ -1,41 +0,0 @@ -# `@life2/game` - -[`@life2/game`][pkg] is a JavaScript implementation of the Life2 simulation -game made to work on V8-compatible runtime, including [Node.js][nodejs], -[Bun][bun], and standard Web browsers. - -The Life2 simulation game is a cellular automaton software following the same -aspect as the traditional [Conway's Game of Life][gol], except it separates -cells in two teams (so called "groups" or "societies"). -The principal objectives behind Life2 is to analyze the behavior of societies -given the rules we defined for them: *how does members of a same society -interact with each other (growth, death, ...)?* *How do two society can live -together when they are different and live in a world where the rules encourage -one to takeover the other?* - -[pkg]: https://www.npmjs.com/package/@life2/game -[nodejs]: https://nodejs.org/ -[bun]: https://bun.sh -[gol]: https://en.wikipedia.org/wiki/Conway's_Game_of_Life - -## Installation - -The package is distributed via the [NPM][npm] registry: - -```shell -# With NPM -npm install -E @life2/game - -# With Yarn -yarn add -E @life2/game -``` - -[npm]: https://npmjs.com - -## Usage - -TODO(nc0): write package a provide a simple usage example there - -## Documentation - -TODO(nc0): write documentation and link it there |