Merge pull request #19 from VanNostrand/documentation

Documentation-Branch v2

cockatrice/src/abstractclient.h

@@ -89,4 +89,4 @@ public:
 	static PendingCommand *prepareAdminCommand(const ::google::protobuf::Message &cmd);
 };
 
-#endif
+#endif

cockatrice/src/arrowtarget.h

@@ -32,4 +32,4 @@ public:
 	void removeArrowTo(ArrowItem *arrow) { arrowsTo.removeAt(arrowsTo.indexOf(arrow)); }
 };
 
-#endif
+#endif

cockatrice/src/chatview.h

@@ -50,4 +50,4 @@ signals:
 	void deleteCardInfoPopup(QString cardName);
 };
 
-#endif
+#endif

cockatrice/src/client_metatypes.h

@@ -26,4 +26,4 @@ Q_DECLARE_METATYPE(QList<ServerInfo_User>)
 Q_DECLARE_METATYPE(Event_ReplayAdded)
 
 
-#endif
+#endif

cockatrice/src/counter_general.h

@@ -14,4 +14,4 @@ public:
 	void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget);
 };
 
-#endif
+#endif

cockatrice/src/dlg_cardsearch.h

@@ -21,4 +21,4 @@ public:
 	QSet<QString> getCardColors() const;
 };
 
-#endif
+#endif

cockatrice/src/gametypemap.h

@@ -5,4 +5,4 @@
 
 typedef QMap<int, QString> GameTypeMap;
 
-#endif
+#endif

cockatrice/src/localclient.h

@@ -18,4 +18,4 @@ private slots:
 	void itemFromServer(const ServerMessage &item);
 };
 
-#endif
+#endif

cockatrice/src/localserverinterface.h

@@ -20,4 +20,4 @@ public slots:
 	void itemFromClient(const CommandContainer &item);
 };
 
-#endif
+#endif

cockatrice/src/playertarget.h

@@ -35,4 +35,4 @@ public:
 	AbstractCounter *addCounter(int _counterId, const QString &_name, int _value);
 };
 
-#endif
+#endif

cockatrice/src/soundengine.h

@@ -31,4 +31,4 @@ public slots:
 
 extern SoundEngine *soundEngine;
 
-#endif
+#endif

cockatrice/src/tab_admin.h

@@ -46,4 +46,4 @@ public:
 	bool getLocked() const { return locked; }
 };
 
-#endif
+#endif

cockatrice/src/userinfobox.h

@@ -24,4 +24,4 @@ public slots:
 	void updateInfo(const QString &userName);
 };
 
-#endif
+#endif

cockatrice/src/userlist.h

@@ -92,4 +92,4 @@ public:
 	void sortItems();
 };
 
-#endif
+#endif

common/color.h

@@ -32,4 +32,4 @@ inline color makeColor(int r, int g, int b)
 	return result;
 }
 
-#endif
+#endif

common/server_arrowtarget.h

@@ -7,4 +7,4 @@ class Server_ArrowTarget : public QObject {
 	Q_OBJECT
 };
 
-#endif
+#endif

doc/usermanual/Usermanual.tex

@@ -194,13 +194,20 @@ Start the oracle.exe (the installer does this automatically) and let it generate
 \end{enumerate}
 Congratulations, you may now use Cockatrice!
 
-\subsubsection{Install latest experimental on Linux}
+\subsubsection{Linux and BSD}
+The following procedures have been tested with Debian Wheezy, Fedora 18 and FreeBSD 9.1.
+If you use Gentoo with KDE you have the needed prerequisites and may continue with downloading the source.
+If you use Bodhi or Arch Linux (AUR) or another distribution that includes Cockatrice, you might install Cockatrice from the default packages -- though the package might be old, 
+so you probably should continue with this howto.
+
+Before you install new software, you should update your system. The following instructions failed on a fresh installation of Fedora 18 and FreeBSD 9.1 until the systems were updated.
 \begin{enumerate}
  \item You need to install the build tools and dependencies. This varies between the Linux distributions.
  \begin{description}
-  \item[Ubuntu] \shellcmd{sudo apt-get install build-essential git libqt4-dev qtmobility-dev libprotobuf-dev protobuf-compiler cmake}
+  \item[Debian, Ubuntu and spin-offs] \shellcmd{sudo apt-get install build-essential git libqt4-dev qtmobility-dev libprotobuf-dev protobuf-compiler cmake}
   \item[Fedora] \shellcmd{sudo yum groupinstall "Development Tools"\\
   yum install qt-devel qt-mobility-devel protobuf-devel protobuf-compiler cmake}
+  \item[FreeBSD] \shellcmd{pkg\_add -r qt4 qt4-linguist qt4-moc qt4-qmake qt4-rcc qt4-uic git cmake protobuf}
  \end{description}
  \item Download the sources from github via \\ \shellcmd{cd\\ git clone https://github.com/Daenyth/Cockatrice.git}
  \item To compile the sources, change into the newly created directory, create a build directory and invoke cmake:\\
@@ -208,12 +215,11 @@ Congratulations, you may now use Cockatrice!
 mkdir build \\
 cd build \\
 cmake ..\\
-make\\
+make}\\
-sudo make install
-}\\
 If you have some issues with pthread\_* add 'pthread' to the ``target\_link\_libraries'' entry in the \shellcmd{CMakeFiles.txt} in \shellcmd{Cockatrice/common}.
-
+ \item You may install the program into the directory \shellcmd{/usr/local} by typing \shellcmd{sudo make install} but you should also be able to start 
- \item Finish up the installation: Run \shellcmd{oracle} and download available cards, denn run \shellcmd{cockatrice}.
+ cockatrice and the oracle from the build directory.
+ \item Before you start Cockatrice for the first time, run \shellcmd{oracle -dlsets} and download available cards, denn run \shellcmd{cockatrice}.
 The default paths for decks, pics, cards and tokens are located in \\ \shellcmd{/home/<user>/.local/share/data/Cockatrice/Cockatrice}.
 \end{enumerate}