X-Git-Url: https://git.sur5r.net/?p=fstl;a=blobdiff_plain;f=README.md;fp=README.md;h=a8a3d18422b7cb11b477bc29b4b6c197fecaee0a;hp=b4ab04b55bf6ee1f58861c01d59e3b3d5b1b786e;hb=0da9fdf2b9623665a991990e57485a007645eba6;hpb=5dd213695da2eb22219ac5143aa8b5cfe7c89559 diff --git a/README.md b/README.md index b4ab04b..a8a3d18 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,12 @@ Issues and minor pull requests are welcome; the project is under 1K lines of code and should be fairly approachable. ## Screenshot -![Eiffel tower](http://mattkeeter.com/projects/fstl/eiffel.png) +![Eiffel tower](http://mattkeeter.com/projects/fstl/eiffel.png) (credit to [Pranav Panchal](https://grabcad.com/pranav.panchal)) ## Building -The only dependency for `fstl` is [Qt](https://www.qt.io). +The only dependency for `fstl` is [Qt 5](https://www.qt.io). ### macOS @@ -45,6 +45,25 @@ This should produce two new files in the root directory: - `fstl.app` is a standalone application that can be copied to `/Applications` - `fstl.dmg` is a disk image that can be given to a friend +### Linux + +Install Qt with your distro's package manager (required libraries are Core, Gui, +Widgets and OpenGL, e.g. `qt5-default` and `libqt5opengl5-dev` on Debian). + +You can build fstl with qmake (in some distros qmake-qt5) or with CMake: +``` +git clone https://github.com/mkeeter/fstl +cd fstl +mkdir build +cd build + +qmake ../qt/fstl.pro # For qmake build +cmake .. # For CMake build + +make -j8 +./fstl +``` + -------------------------------------------------------------------------------- # License