diff --git a/README.md b/README.md index 818021b..ed06aa8 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,20 @@ # triangle_group_limit_set - visualizer for triangle group limit sets in the projective plane -This program visualizes the fractal limit set of triangle groups in SL(3,R) in the projective plane. +This program visualizes the fractal limit set of triangle groups in SL(3,R) in the projective plane. For the mathematical details, see [our paper]. ## Installation & Prerequisites ## -This program is written C and exclusively for Linux. It uses [Cairo] for drawing and X11 for input, which means it will only run in the X window system. Besides these, the only required library is the [Gnu Scientific Library (GSL)] including CBLAS. +This program is written C and only runs on Linux with the X window system (because that's what I happen to be using). It uses [Cairo] for drawing and X11 for input. We also require the [Gnu Scientific Library (GSL)] including CBLAS. -To build, make sure GCC as well as these libraries are installed, and run +To build, just make sure GCC as well as these libraries are installed, and run make Then we can run it for example like this: - ./limit_set 5 5 5 1 1 1 1.0 1.0 + ./limit_set 5 5 5 1 1 1 1.0 -The arguments are 6 integers (p1, p2, p3, q1, q2, q3) and two floating point numbers (t,s) describing the triangle group under consideration (initially, t and s can be changed with the arrow keys). -The last argument is optional; if it is not given, it defaults to s = 1. +The arguments are 6 integers (p1, p2, p3, q1, q2, q3) and a floating point numbers t. Together they discribe the triangle group under consideration (t can be changed with the arrow keys). ## Key bindings @@ -48,3 +47,4 @@ Drag the mouse to move the image, drag with Shift pressed to rotate. [Cairo]: https://cairographics.org/ [Gnu Scientific Library (GSL)]: https://www.gnu.org/software/gsl/ +[our paper]: https://arxiv.org/abs/2106.11349