aly/servatrice
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #86 from VanNostrand/doc

Browse source 
Usermanual update
This commit is contained in:
Gavin Bisesi 2014-06-15 08:11:02 -04:00
commit 74163dba5d
2 changed files with 3 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
doc/usermanual/Usermanual.pdf
View file

Binary file not shown.

9
doc/usermanual/Usermanual.tex
View file

@ -83,7 +83,7 @@ If someone runs his own server where you can register a user profile, read his d
\section{Downloading and Installing the Cockatrice Program} \section{Downloading and Installing the Cockatrice Program}
Due to a legal dispute there are currently no official builds left, so currently you have to build your own binaries. Due to a legal dispute there are currently no official builds left, so currently you have to build your own binaries.
\subsection{Client compilation} \subsection{Building the Client}
\subsubsection{Windows} \subsubsection{Windows}
There should be two ways to compile Cockatrice: With Visual Studio 2010 and with MinGW. There should be two ways to compile Cockatrice: With Visual Studio 2010 and with MinGW.
As the Visual Studio method is more complicated and might not work, you should do it with MinGW. As the Visual Studio method is more complicated and might not work, you should do it with MinGW.
@ -204,7 +204,7 @@ Before you install new software, you should update your system. The following in
\begin{enumerate} \begin{enumerate}
\item You need to install the build tools and dependencies. This varies between the Linux distributions. \item You need to install the build tools and dependencies. This varies between the Linux distributions.
\begin{description} \begin{description}
\item[Debian, Ubuntu and spin-offs] \shellcmd{sudo apt-get install build-essential git libqt4-dev qtmobility-dev libprotobuf-dev protobuf-compiler cmake} (see note below regarding pthread) \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"\\ \item[Fedora] \shellcmd{sudo yum groupinstall "Development Tools"\\
yum install qt-devel qt-mobility-devel protobuf-devel protobuf-compiler cmake} yum install qt-devel qt-mobility-devel protobuf-devel protobuf-compiler cmake}
\item[FreeBSD 9] \shellcmd{pkg\_add -r qt4 qt4-linguist qt4-moc qt4-qmake qt4-rcc qt4-uic git cmake protobuf} \item[FreeBSD 9] \shellcmd{pkg\_add -r qt4 qt4-linguist qt4-moc qt4-qmake qt4-rcc qt4-uic git cmake protobuf}
@ -217,9 +217,6 @@ mkdir build \\
cd build \\ cd build \\
cmake ..\\ cmake ..\\
make}\\ make}\\
\begin{framed}
If you have linking errors with pthread\_* add 'pthread' to the ``target\_link\_libraries'' entry in the \shellcmd{CMakeFiles.txt} in \shellcmd{Cockatrice/common}, e.g. for Xubuntu, then continue the make process.
\end{framed}
\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 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
cockatrice and the oracle from the build directory. 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, then run \shellcmd{cockatrice}. \item Before you start Cockatrice for the first time, run \shellcmd{oracle -dlsets} and download available cards, then run \shellcmd{cockatrice}.
@ -229,7 +226,7 @@ The default paths for decks, pics, cards and tokens are located in \\ \shellcmd{
\subsubsection{MacOS X} \subsubsection{MacOS X}
TODO, please contribute this section! See Linux section, then use the \shellcmd{prepareMacRelease.sh} script from Cockatrice. TODO, please contribute this section! See Linux section, then use the \shellcmd{prepareMacRelease.sh} script from Cockatrice.
\subsection{Server compilation} \subsection{Building the Server}
You don't need your own server if you plan to play only. But as Cockatrice is open source you are free to run your own. You don't need your own server if you plan to play only. But as Cockatrice is open source you are free to run your own.
The compilation works like already written above, but instead of invoking \shellcmd{cmake ..}, you have to do it like this: The compilation works like already written above, but instead of invoking \shellcmd{cmake ..}, you have to do it like this:
\begin{itemize} \begin{itemize}