]> git.sur5r.net Git - fstl/commitdiff
Adding README
authorMatt Keeter <matt.j.keeter@gmail.com>
Sat, 15 Mar 2014 18:51:22 +0000 (14:51 -0400)
committerMatt Keeter <matt.j.keeter@gmail.com>
Sat, 15 Mar 2014 18:51:22 +0000 (14:51 -0400)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..f50a632
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+`fstl` is a viewer for [.stl files](http://en.wikipedia.org/wiki/STL_\(file_format\)).
+
+Here's a screenshot:  
+![Eiffel tower](http://mattkeeter.com/projects/fstl/eiffel.png)  
+(credit to [Pranav Panchal](https://grabcad.com/pranav.panchal))
+
+It is designed to quickly load and render very high-polygon models;
+showing 2 million triangles at 60+ FPS on a mid-range laptop.
+
+For more details, see the [project page](http://mattkeeter.com/projects/fstl).
+
+Issues and pull requests are welcome;
+the project is under 1K lines of code and should be fairly approachable.
+
+--------------------------------------------------------------------------------
+
+*p.s.* In my day job, I'm an engineer at [Formlabs](http://formlabs.com).
+If you think `fstl` is cool, you should check out our
+[jobs page](http://formlabs.com/jobs) -- we're hiring software developers
+and engineers of all stripes to work on interesting, hard problems in
+consumer-level 3D printing.
+