From 79003ef9688695db056ca30103d0e26290c0d58b Mon Sep 17 00:00:00 2001
From: mrb0nk500 <b0nk@b0nk.xyz>
Date: Sat, 12 Oct 2019 21:37:29 -0400
Subject: Correct some errors, and add some extra documentation in the readme.

This is the first commit, to the public version.
---
 README | 35 ++++++++++++++++++++++++++---------
 1 file changed, 26 insertions(+), 9 deletions(-)

(limited to 'README')

diff --git a/README b/README
index 4de8175..94c2e3e 100644
--- a/README
+++ b/README
@@ -19,7 +19,7 @@ clld is a simple collision checker, that takes two 2D, or 3D points, tests
 the collision of the points, and outputs the results to stdout.
 
 It can do many different types of collision checks, including
-tile heightmap, AABB, per pixel, and more.
+tile heightmap, AABB, and (possibly) more.
 
 
 
@@ -51,14 +51,14 @@ To install clld, run:
 $ make install
 
 You can change the install prefix, and bin directories, by changing
-the PREFIX, and BIN environment variables.
+the PREFIX, and BIN_DIR environment variables.
 
-By default, PREFIX, and BIN are set to /usr/local, and bin respectivly.
+By default, PREFIX, and BIN_DIR are set to /usr/local, and bin respectivly.
 
 
 2.3. Running
 
-Run `clld --help`, or `clld -h` to get information about the options.
+Run `clld -h` to get information about the options.
 
 
 
@@ -70,22 +70,34 @@ cursor position, and the floor position.
 The input format looks like this:
 
 <collision type>
+<cursor width>, <cursor height>
 <collision type specific data>
 <cursor x>, <cursor y>[, <cursor z>]
+<cursor x velocity>, <cursor y velocity>
+<floor width>, <floor height>
 <floor x>, <floor y>[, <floor z]
 
 The collision type is the type of collision check that clld will use.
 
+The Cursor width, and height are just that.
+
 Cursor x, y, and z are the coordinates of the cursor, which clld will
 test against the floor's position.
 
+The Cursor x, and y velocitiy is the speed which the cursor is moving
+at, in either axies.
+
 Floor x, y, and z are the coordinates of the floor, which is used by
 clld as the reference position that will be tested against the cursor.
 
+The Floor width, and height is just like the Cursor's.
+
 The datatypes for each of the fields are:
 
 Collision type:			flag
+Cursor, and floor width/height:	integer
 Cursor, and floor position:	integer, or floating point
+Cursor axial velocites:		floating point
 
 
 
@@ -96,22 +108,27 @@ collision flag, the grounded flag, and the cursor position.
 
 The output format looks like this:
 
-<collision flag>
+<x collision flag>, <y collision flag>
 <grounded flag>
 <cursor x>, <cursor y>[, <cursor z>]
+<cursor x velocity>, <cursor y velocity>
 
-The collision flag is set, when a collision has occured.
+The x, and y collision flags are set, when a collision has occured on
+either the x, or y axis.
 
 The grounded flag is set when the cursors y coordinate matches
 the floors y coordinate.
 
 Cursor x, y, and z are the new coordinates for the cursor to be set to.
 
+The Cursor x, and y velocity are the new speed values of the cursor.
+
 The datatypes for each of the fields are:
 
-Collision flag:		flag
-Grounded flag:		flag
-Cursor position:	integer, or floating point
+Collision flag:			flag
+Grounded flag:			flag
+Cursor position:		integer, or floating point
+Cursor axial velocities:	floating point
 
 
 
-- 
cgit v1.2.3-13-gbd6f