From 581b0d975caad99f3a0cb14042efd1d6f3b905cb Mon Sep 17 00:00:00 2001 From: Gambhiro Date: Wed, 20 Jan 2016 18:48:21 +0000 Subject: [PATCH] readme upd --- Data/BuildGuideLinux.md | 58 ++++++++++++++++ Data/BuildGuideMacOSX.md | 42 ++++++++++++ README.md | 140 +++++++-------------------------------- 3 files changed, 125 insertions(+), 115 deletions(-) create mode 100644 Data/BuildGuideLinux.md create mode 100644 Data/BuildGuideMacOSX.md diff --git a/Data/BuildGuideLinux.md b/Data/BuildGuideLinux.md new file mode 100644 index 0000000..eced55e --- /dev/null +++ b/Data/BuildGuideLinux.md @@ -0,0 +1,58 @@ +# 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 +``` + +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 +``` diff --git a/Data/BuildGuideMacOSX.md b/Data/BuildGuideMacOSX.md new file mode 100644 index 0000000..5def351 --- /dev/null +++ b/Data/BuildGuideMacOSX.md @@ -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 +``` + diff --git a/README.md b/README.md index 1b0567a..01c0706 100644 --- a/README.md +++ b/README.md @@ -5,17 +5,36 @@ A Qt-based fractal flame editor which uses a C++ re-write of the flam3 algorithm named Ember and a GPU capable version named EmberCL which implements a portion of the cuburn algorithm in OpenCL. -# Download +# Install -Windows: TODO +## Windows -Linux: TODO +Download: [Fractorium_Beta_0.9.9.3.msi](https://drive.google.com/file/d/0Bws5xPbHJph6Z3JiTHlYZ21YVFU/view?usp=sharing) -Mac OS/X (10.9+): TODO +## Linux + +Enable `universe` in the Ubuntu Software Center: + +- open the Edit menu +- select Software Sources... +- enable "Community maintained ... `universe`" + +Add the Ubuntu PPA and install: + +``` +sudo apt-add-repository ppa:fractorium/ppa +sudo apt-get update +sudo apt-get install fractorium +``` + +## Mac OS/X (10.9+) + +TODO # Building from git ## Windows + Install Git-GUI and clone `https://github.com/mfeemster/fractorium.git` Then follow: @@ -24,117 +43,8 @@ Then follow: ## 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 -``` - -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 -``` +See [Building Guide for Linux](./Data/BuildGuideLinux.md) ## Mac OS/X 10.9+ -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 -``` - -# OpenCL tips - -Nvidia, Ati, Intel. - -## Windows - -TODO - -## Linux - -TODO - -## Mac OS/X - -TODO +See [Building Guide for Mac OS/X](./Data/BuildGuideMacOSX.md)