Browse Source

edit readmes

olinox 9 years ago
parent
commit
cac8778435
2 changed files with 25 additions and 2 deletions
  1. 16 2
      README.md
  2. 9 0
      tests/gridviewer/readme.md

+ 16 - 2
README.md

@@ -1,6 +1,20 @@
-** pypog **
+** pypog - Python Play on Grid**
 
-[GNU License](https://github.com/olinox14/pypog/blob/master/LICENSE.txt) 
+pypog is under [GNU License](https://github.com/olinox14/pypog/blob/master/LICENSE.txt) 
 
 [![Build Status](https://travis-ci.org/olinox14/pypog.svg?branch=master)](https://travis-ci.org/olinox14/pypog) [![Coverage Status](https://coveralls.io/repos/github/olinox14/pypog/badge.svg?branch=master)](https://coveralls.io/github/olinox14/pypog?branch=master)
 
+#### Pypog is currently on developpement, do not hesitate to involve!
+
+
+Generates a grid and implement it in your game!
+
+pypog gives you access to many tools to work with grids:
+
+* Square or hexagonal grids
+* Geometrical functions: line, zone, rectangle, cone
+* Each of them come in 2D or 3D or 3d version
+* Pencil: freehand, line, zone, rectangles, zone, boundaries
+* Pathfinding (based on A* algorythm)
+* 3D space occupation
+

+ 9 - 0
tests/gridviewer/readme.md

@@ -0,0 +1,9 @@
+### GridViewer
+
+GridViewer is a convenient tool to control the result of pypog tests.
+
+It display a list of coordinates on a simple grid from the cells you selected, or show you the cells corresponding to your list of coordinates.
+
+To run GridViewer:
+
+	python GridViewer.py