<html>
+<head>
<title>Building Magic Smoke</title>
</head>
<body>
<h2>Prerequisites</h2>
You need <a href="http://qt.nokia.com/downloads">Trolltech/Nokias Qt</a> Open Source edition
-version 4.7 or any newer.<p/>
+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.<p/>
You also need <a href="http://www.openssl.org/">OpenSSL</a> 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
The source documentation needs <a href="http://www.doxygen.org/">Doxygen</a> in order to be built.
+<h2>Starting from GIT</h2>
+
+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:
+<pre>
+git clone git://silmor.de/konrad/smoke.git magicsmoke
+cd magicsmoke
+</pre>
+
+You may want to check out a specific tag. Please consult your git manual on how to do this.<p>
+
+Next you have to initialize your local copy, usually it is enough to run:
+<pre>
+git submodule init
+git submodule update
+</pre>
+
+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.
+
<h2>Building</h2>
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).<p/>
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).<p/>
-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.<p/>
Unixoid systems:<br/>
<tt>make <i>rule</i></tt><p/>
+MacOS/X:<br/>
+<tt>make macosx</tt><p/>
+
Windows with MinGW:<br/>
<tt>mingw32-make <i>rule</i></tt><p/>
These are the packages listed in debian/control as Build-Depends.<p>
Then simply build the packages:<br/>
-<tt>sh$ fakeroot debian/rules binary</tt><p>
+<tt>fakeroot debian/rules binary</tt><br/>
+or:<br/>
+<tt>make dpkg</tt><p>
You should then have three packages:
<ul>
<html>
+<head>
<title>Magic Smoke Documentation</title>
</head>
<body>
<h2>Copyright</h2>
-© Konrad Rosenbaum, 2007-2011<br/>
+© Konrad Rosenbaum, 2007-2012<br/>
© Peter Keller, 2007/8<p>
MagicSmoke is licensed under <a href="copying-gpl.html">GPL</a> (Client), <a href="copying-agpl.html">AGPL</a> (Server), and <a href="copying-fdl.html">FDL</a> (Documentation).
<h2>Introduction</h2>
-Magic Smoke was written to keep track of tickets for events (like concerts or theatric plays), sell them online or through retailers. It does not keep your books for you - it can only handle the orders and the payment data that is entered into it.<p>
+Magic Smoke was written to keep track of tickets for events (like concerts or theatric plays), sell them online or through your box office. It does not keep your books for you - it can only handle the orders and the payment data that is entered into it.<p>
MagicSmoke is a client-server system in an almost classic 3-tier architecture:
<ul>
</ul></li>
</ul><p>
-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).<p>
+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).<p>
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.
<h2>Building/Installing Magic Smoke</h2>
<ul>
-<li><a href="build.html">Building and installing MagicSmoke</a></li>
+<li><a href="build.html">Building and Installing MagicSmoke from Source</a></li>
+<li><a href="preinst.html">Installing pre-packaged MagicSmoke</a></li>
<li><a href="server.html">Creating a Server Instance</a></li>
+<li><a href="client/config.html">Configuring the Client</a></li>
<li>Templates:<ul>
<li><a href="template.html">Web Template Design</a></li>
<li><a href="prog_odttemplate.html">ODT Template Design</a></li>
--- /dev/null
+<html>
+<head>
+<title>MagicSmoke Installing Pre-Packaged</title>
+</head>
+<body>
+<h1>MagicSmoke Installing Pre-Packaged</h1>
+
+The easiest way of installing MagicSmoke is using pre-packaged installation files.
+
+<h2>Debian and Ubuntu</h2>
+
+The main repository for MagicSmoke provides packages for a compatible release of Debian and the current release of Ubuntu. See <a href="http://smoke.silmor.de">http://smoke.silmor.de</a> for details.<p>
+
+You can enter a line like this to your <tt>/etc/apt/sources.list</tt> file:
+<pre>deb http://smoke.silmor.de/debian <i>dist</i> extra</pre>
+The <tt><i>dist</i></tt> keyword must be replaced by the distribution of Debian or Ubuntu that you want to target. After that you can install MagicSmoke with Apt:
+<pre>apt-get update
+apt-get install magicsmoke2-client magicsmoke2-server magicsmoke2-doc</pre>
+<p>
+
+Alternatively download the packages from the pool directories (<a href="http://smoke.silmor.de/debian/dpool">Debian</a>; <a href="http://smoke.silmor.de/debian/upool">Ubuntu</a>) and install them with <tt>dpkg -i <i>package</i></tt>.<p>
+
+<h2>Other Linux'es</h2>
+
+<a href="http://smoke.silmor.de/download/">Download</a> the msmoke2-*.tgz files of the newest version. Depending on your file system layout you will want to enter /usr, /usr/local or /opt to unpack those files
+
+<h2>Windows</h2>
+
+Only the client is available pre-packaged for Windows.<p>
+
+<a href="http://smoke.silmor.de/download/">Download</a> the Windows packages...
+<!--TODO: specify the actual procedure-->
+
+<h2>MacOS/X</h2>
+
+Only the client is available pre-packaged for MacOS/X.<p>
+
+<a href="http://smoke.silmor.de/download/">Download</a> the *.dmg file of the newest version, open it and drag the contained *.app to a place where you want MagicSmoke to be installed. It is recommended to move the app to your hard drive, to make it easier to start next time.
+
+
+
+</body>
+</html>
\ No newline at end of file
projects / konrad/smoke.git / commitdiff