From f026d26a6b3afb5a1a4dee5cabeb0258a54c42f3 Mon Sep 17 00:00:00 2001 From: Konrad Rosenbaum Date: Sun, 25 Dec 2011 15:47:32 +0100 Subject: [PATCH] more base docu --- doc/build.html | 30 +++++++++++++++++++++++++++--- doc/index.html | 11 +++++++---- doc/preinst.html | 43 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 77 insertions(+), 7 deletions(-) create mode 100644 doc/preinst.html diff --git a/doc/build.html b/doc/build.html index 809bae4..eb1450e 100644 --- a/doc/build.html +++ b/doc/build.html @@ -1,4 +1,5 @@ + Building Magic Smoke @@ -17,7 +18,7 @@

Prerequisites

You need Trolltech/Nokias Qt Open Source edition -version 4.7 or any newer.

+version 4.7 or any newer. Qt is also needed to generate some code that the server relies upon - even though the server itself is written in PHP and does not need Qt at runtime.

You also need OpenSSL installed and Qt needs to be built with SSL-support. While the pure web-UI can run without SSL, it is highly recommended that you enable @@ -28,6 +29,24 @@ You need a C++ compiler that works with Qt. I usually recommend GCC 4.x for Linu The source documentation needs Doxygen in order to be built. +

Starting from GIT

+ +There are several components in MagicSmoke that rely on version information being available. So you have to create a clone of the main GIT repository first: +
+git clone git://silmor.de/konrad/smoke.git magicsmoke
+cd magicsmoke
+
+ +You may want to check out a specific tag. Please consult your git manual on how to do this.

+ +Next you have to initialize your local copy, usually it is enough to run: +

+git submodule init
+git submodule update
+
+ +The setup assumes that the needed submodules are in repositories with URLs relative to MagicSmoke itself, like it is the case with the main repository listed above. If this does not work you have to clone all submodules manually. +

Building

Both server and client depend on some shared code that is pre-compiled into some of their components. So it is easiest to do a complete build (unless you are familiar with the sources).

@@ -36,11 +55,14 @@ Make sure that the correct version of QMake is in your PATH (you can check this Go to the main directory of MagicSmoke. There are a few lines at the start of the Makefile that you can adjust to better match your system (defaults should be fine for most cases).

-There is no support for automatic builds without MinGW on Windows. I have only tested Linux, MacOS/X and Windows/MinGW, so there is no guarantee for any other system. +There is no support for automatic builds without MinGW on Windows. I have only tested Linux, MacOS/X and Windows/MinGW, so there is no guarantee for any other system.

Unixoid systems:
make rule

+MacOS/X:
+make macosx

+ Windows with MinGW:
mingw32-make rule

@@ -96,7 +118,9 @@ Additionally MagicSmoke needs some pre-requisites to build:
These are the packages listed in debian/control as Build-Depends.

Then simply build the packages:
-sh$ fakeroot debian/rules binary

+fakeroot debian/rules binary
+or:
+make dpkg

You should then have three packages:

-The Client is able to run on almost any system that Qt runs on. It has been tested on Linux (Debian), Windows (32bit, MinGW) and MacOS/X (XCode, Snow Leopard).

+The Client is able to run on almost any system that Qt runs on. It has been tested on Linux (Debian squeeze/amd64 and Ubuntu LTS/x86), Windows (32bit, MinGW) and MacOS/X (XCode, Snow Leopard).

The Server has been developed to run on Linux and other Unixes. It needs Apache, PHP5 and a MySQL or Postgres database. It may run on other systems, but it has never been tested on them. @@ -53,8 +54,10 @@ This software comes with no warranty at all. You use it at your own risk.

Building/Installing Magic Smoke