summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@gmail.com>2010-11-14 21:20:43 -0500
committerTavian Barnes <tavianator@gmail.com>2010-11-14 21:20:43 -0500
commit8fe33a340b8979a73fa84f201c15519a9b5d0266 (patch)
tree12cdbb1c1b9a48f533ab36980602785be1e1deeb /README
parent20a55aa78050d94b187d4edfaac91ea00efea505 (diff)
downloaddimension-8fe33a340b8979a73fa84f201c15519a9b5d0266.tar.xz
Document libdimension with Doxygen.
Diffstat (limited to 'README')
-rw-r--r--README12
1 files changed, 4 insertions, 8 deletions
diff --git a/README b/README
index b998a2e..8c4a22d 100644
--- a/README
+++ b/README
@@ -1,9 +1,5 @@
This is Dimension, a project to create a GPLed, POV-Ray compatible ray tracer.
-It is currently stable but lacking in features, to the point of unusability.
-But if you want to try it anyway, see the INSTALL file for how to compile and
-run it. For a quick demo, run ./autogen.sh && ./configure && make check, and
-look at tests/dimension/demo.{pov,png}.
-
-Documentation for the `dimension' program will eventually be in the doc/
-directory. (Out of date) API documentation for the ray tracing library
-libdimension is also in doc/.
+It is currently stable but lacking in features. But if you want to try it
+anyway, see the INSTALL file for how to compile and run it. For a quick demo,
+run ./autogen.sh && ./configure && make check, and look at
+tests/dimension/demo.{pov,png}.