aboutsummaryrefslogtreecommitdiff
path: root/readme
diff options
context:
space:
mode:
authorrodri <rgl@antares-labs.eu>2020-04-13 09:52:35 +0000
committerrodri <rgl@antares-labs.eu>2020-04-13 09:52:35 +0000
commit0c954e9b9a7579afaf0419471dfec0452dd202e0 (patch)
treeb7eadbfa58ab7aa57ca4451045f67230b94c786f /readme
parentfc201ec63c3a98b34bf8abb1b9e72e1551e81d55 (diff)
downloadlibgeometry-0c954e9b9a7579afaf0419471dfec0452dd202e0.tar.gz
libgeometry-0c954e9b9a7579afaf0419471dfec0452dd202e0.tar.bz2
libgeometry-0c954e9b9a7579afaf0419471dfec0452dd202e0.zip
add a readme
Diffstat (limited to 'readme')
-rw-r--r--readme16
1 files changed, 16 insertions, 0 deletions
diff --git a/readme b/readme
new file mode 100644
index 0000000..1117530
--- /dev/null
+++ b/readme
@@ -0,0 +1,16 @@
+libgeometry
+
+Libgeometry is a computational geometry library built with graphics
+and simulators in mind.
+
+It isn't yet finished, but it already provides some nice fundamental
+blocks with which to build more complex processors. It also is an
+improvement over the stock libgeometry shipping with plan9(front).
+
+To use it: mk install it and include the geometry.h from your
+projects, then link against the generated libgeometry.a$O.
+
+You can find the documentation in doc/, although it doesn't document
+the whole API at the moment. Points (of which are also vectors),
+Matrices and Quaternions are mostly complete. When in doubt, read
+the code.