Merge pull request #8 from remyroez/release

リリース作業

README.md

@@ -1,2 +1,57 @@
-# love-life-like
-[WIP] :space_invader: Life-like cellular automaton with LÖVE
+# LIFE-LIKE
+
+:space_invader: Generic Life-like cellular automaton with LÖVE
+
+![Screenshot](https://user-images.githubusercontent.com/1193542/59155571-1e1f3f00-8ac7-11e9-91bf-3011930f4422.png)
+
+## Menu
+
+- File
+    - New: Create a new board.
+    - Open: Open board file.
+    - Save: Save current board file.
+    - Save As: Save board file.
+
+- Window
+    - Control: Toggle 'Control' window.
+    - Optional Rule: Toggle 'Optional Rule' window.
+
+## Controls
+
+- Draw cell: Main mouse button
+- Remove cell: Sub mouse button
+- Restart: F5
+- Toggle GUI: F12
+- Capture a screenshot: Print screen
+    - Save a screenshot to a [save-directory](https://love2d.org/wiki/love.filesystem)
+
+## Getting Started
+
+### Quick Start
+
+1. Download and install [LÖVE](https://love2d.org/) 11.2.
+1. Download the latest version of `love-life-like.love` game distribution from release.
+1. Open the distribution with LÖVE.
+
+### Build and Run from Source
+
+```
+git clone https://github.com/remyroez/love-life-like.git
+cd love-life-like/game
+love .
+```
+
+## Requirements
+
+- [LÖVE](https://love2d.org/) 11.2
+
+## Libraries
+
+- [Slab](https://github.com/coding-jackalope/Slab) v0.3.0 (customized)
+- [binser](https://github.com/bakpakin/binser) 0.0-8
+- [FBlove](https://love2d.org/forums/viewtopic.php?f=5&t=85013) for love11.1
+- [middleclass](https://github.com/kikito/middleclass) v4.1.1
+
+## License
+
+MIT License