This commit is contained in:
mfeemster
2016-01-29 17:02:26 -08:00
11 changed files with 194 additions and 125 deletions

64
Data/BuildGuideLinux.md Normal file
View File

@ -0,0 +1,64 @@
# Building Guide for Linux
Install `git` and clone the repository:
```
sudo apt-get install git
git clone https://github.com/mfeemster/fractorium
```
Install the dependencies.
For Ubuntu 15.04 (vivid) and 15.10 (wily):
```
sudo apt-get install g++ libdbus-1-dev libgl1-mesa-dev libgl-dev libglm-dev libjpeg-dev libpng12-dev libtbb-dev libxml2-dev qt5-default qt5-qmake qtbase5-dev libqt5opengl5-dev ocl-icd-libopencl1
```
Install the OpenCL drivers and opencl support for your hardware. For Nvidia:
```
sudo apt-get install nvidia-352 nvidia-352-dev nvidia-opencl-icd-352 nvidia-libopencl1-352 nvidia-prime nvidia-modprobe
```
If you have both Qt 4 and 5 installed, select Qt 5 before compilation:
```
export QT_SELECT=qt5
```
Compile the binary:
```
cd fractorium
qmake
make
```
Run the binary from the release folder:
```
cd Bin/release
./fractorium
```
`sudo make install` will install the files directly. `sudo make uninstall` is
also available.
You can also compile a `.deb` package to install locally. A few more tools will
be necessary:
```
sudo apt-get install bzr bzr-builddeb dh-make debhelper
```
A helper script is available, use `package-linux.sh` in the project root. It
will create `~/PPA/fractorium-VERSION` as a work folder, by default it builds a
signed source package.
For local use you probably want an unsigned binary package:
```
cd fractorium
./package-linux.sh --binary-only --unsigned
```

42
Data/BuildGuideMacOSX.md Normal file
View File

@ -0,0 +1,42 @@
# Building Guide for Mac OS/X
Install Xcode from the App Store. Install [homebrew](http://brew.sh/).
Install `git` and clone the repository:
```
brew install git
git clone https://github.com/mfeemster/fractorium
```
Install the dependencies:
```
brew install qt5 tbb glm dbus jpeg libpng glib libxml2
```
TODO: Confirm if `glib` and `libxml2` are actually needed.
Add the Qt `bin` folder to `PATH` to make `qmake` available. In
`~/.bash_profile` or `~/.bashrc`:
```
PATH=/usr/local/opt/qt5/bin:$PATH
export PATH
```
Compile the binary:
```
cd fractorium
qmake CONFIG-=app_bundle
make
```
Run the binary from the release folder:
```
cd Bin/release
./fractorium
```

12
Data/Fractorium.desktop Normal file
View File

@ -0,0 +1,12 @@
[Desktop Entry]
Version=1.0
Type=Application
Name=Fractorium
GenericName=Fractal flame editor
Comment=Fractal flame editor
Exec=fractorium
TryExec=fractorium
Icon=/usr/share/fractorium/Fractorium.png
Terminal=false
Categories=Graphics;
MimeType=