Add readme

README.adoc

@@ -0,0 +1,44 @@
+= Snake
+Gabriel Augendre <gabriel@augendre.info>
+:toc:
+
+== Dependencies
+
+- Python >= 3.6.5
+- pygame >= 1.9.3
+- pipenv (for dependencies management)
+
+=== Install dependencies
+
+----
+pipenv install
+----
+
+== Run
+
+----
+pipenv run python main.py
+----
+
+== Config
+
+You can change config values in `config.py`. Here are the defaults :
+
+----
+BACKGROUND_COLOR = 0, 0, 0
+APPLE_COLOR = 250, 0, 0
+SNAKE_COLOR = 0, 250, 0
+FONT_COLOR = 250, 250, 250
+
+MAP_SIZE = 41, 31
+TILE_SIZE = 20
+RESOLUTION = MAP_SIZE[0] * TILE_SIZE, MAP_SIZE[1] * TILE_SIZE
+
+INITIAL_SNAKE_SIZE = 3
+----
+
+WARNING: Don't change `RESOLUTION` unless you know what you're doing.
+`RESOLUTION` is currently automatically computed from the map size.
+
+== Roadmap
+- [ ] Add custom maps