diff options
Diffstat (limited to 'readme')
| -rw-r--r-- | readme | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/readme b/readme new file mode 100644 index 0000000..ae04c7f --- /dev/null +++ b/readme @@ -0,0 +1,26 @@ +senseless directions +---------------------- + +convert a series of cardinal directions into a measure of degree +because we all know that NWWWNNNWWN is a sensible way to direct. + +#INCLUDE "senseless.h" + senseless directions can be used as a single-header library. you'll + want the file called senseless.h in the root of the repository. then + just include it in your code and you're good. + +INTERFACE + double senseless_directions(const char *directions, size_t length); + takes a string of [NnEeSsWw] characters and produces a + measure of degree. + +MAKEFILE + if you have make installed you can use the following subcommands. if + make is not installed, you can look at the Makefile for the commands + that are run. + + test + compile and run the tests. + + clean + remove artifacts created by the makefile \ No newline at end of file |