git.sur5r.net Git - fstl/blob - README.md

   1 # fstl
   2
   3 `fstl` is the fastest [.stl file](http://en.wikipedia.org/wiki/STL_\(file_format\)) viewer.
   4
   5 It is designed to quickly load and render very high-polygon models;
   6 showing 2 million triangles at 60+ FPS on a mid-range laptop.
   7
   8 For more details, see the [project page](http://mattkeeter.com/projects/fstl).
   9
  10 Issues and minor pull requests are welcome;
  11 the project is under 1K lines of code and should be fairly approachable.
  12
  13 ## Screenshot
  14 ![Eiffel tower](http://mattkeeter.com/projects/fstl/eiffel.png)
  15 (credit to [Pranav Panchal](https://grabcad.com/pranav.panchal))
  16
  17 ## Building
  18
  19 The only dependency for `fstl` is [Qt 5](https://www.qt.io).
  20
  21 ### macOS
  22
  23 Install Qt from their website or [Homebrew](brew.sh),
  24 making sure `qmake` is on your shell's path.
  25
  26 Then, run through the following set of commands in a shell:
  27 ```
  28 git clone https://github.com/mkeeter/fstl
  29 cd fstl
  30 mkdir build
  31 cd build
  32 qmake ../qt/fstl.pro
  33 make -j8
  34 ./fstl.app/Contents/MacOS/fstl
  35 ```
  36
  37 To package a standalone app, go to the app directory and run `package.sh`
  38
  39 ```
  40 cd ../app
  41 ./package.sh
  42 ```
  43
  44 This should produce two new files in the root directory:
  45 - `fstl.app` is a standalone application that can be copied to `/Applications`
  46 - `fstl.dmg` is a disk image that can be given to a friend
  47
  48 ### Linux
  49
  50 Install Qt with your distro's package manager (required libraries are Core, Gui,
  51 Widgets and OpenGL, e.g. `qt5-default` and `libqt5opengl5-dev` on Debian).
  52
  53 You can build fstl with qmake (in some distros qmake-qt5) or with CMake:
  54 ```
  55 git clone https://github.com/mkeeter/fstl
  56 cd fstl
  57 mkdir build
  58 cd build
  59
  60 qmake ../qt/fstl.pro  # For qmake build
  61 cmake ..              # For CMake build
  62
  63 make -j8
  64 ./fstl
  65 ```
  66
  67 --------------------------------------------------------------------------------
  68
  69 # License
  70
  71 Copyright (c) 2014-2017 Matthew Keeter
  72
  73 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
  74
  75 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  76
  77 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.