diff --git a/README.md b/README.md index a94926ad..d1177ca0 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,29 @@ - - -**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* +

-- [Cockatrice](#cockatrice) -- [Get Involved [![Gitter chat](https://badges.gitter.im/Cockatrice/Cockatrice.png)](https://gitter.im/Cockatrice/Cockatrice)](#get-involved-) -- [Community Resources](#community-resources) -- [Translation Status [![Cockatrice on Transiflex](https://ds0k0en9abmn1.cloudfront.net/static/charts/images/tx-logo-micro.646b0065fce6.png)](https://www.transifex.com/projects/p/cockatrice/)](#translation-status-) -- [Building [![Build Status](https://travis-ci.org/Cockatrice/Cockatrice.svg?branch=master)](https://travis-ci.org/Cockatrice/Cockatrice)](#building-) -- [Building servatrice Docker container](#building-servatrice-docker-container) -- [Running](#running) -- [License](#license) +--- - +**Table of Contents**    [Cockatrice](#cockatrice) | [Get Involved] (#get-involved-) | [Community](#community-resources) | [Translation](#translation-status-) | [Building](#building-) | [Running](#running) | [License](#license) + +--- # Cockatrice Cockatrice is an open-source multiplatform software for playing card games, such as Magic: The Gathering, over a network. It is fully client-server based to prevent any kind of cheating, though it supports single-player games without -a network interface as well. Both client and server are written in Qt, supporting both Qt4 and Qt5. +a network interface as well. Both client and server are written in Qt, supporting both Qt4 and Qt5.
+ # Get Involved [![Gitter chat](https://badges.gitter.im/Cockatrice/Cockatrice.png)](https://gitter.im/Cockatrice/Cockatrice) -Chat with the Cockatrice developers on Gitter. Come here to talk about the application, features, or just to hang out. For support regarding specific servers, please contact that server's admin or forum for support rather than asking here. +Chat with the Cockatrice developers on Gitter. Come here to talk about the application, features, or just to hang out. For support regarding specific servers, please contact that server's admin or forum for support rather than asking here.
+ # Community Resources -- [reddit r/Cockatrice](http://reddit.com/r/cockatrice) -- [Woogerworks Server & Forums](http://www.woogerworks.com) - [Cockatrice Official Wiki](https://github.com/Cockatrice/Cockatrice/wiki) +- [reddit r/Cockatrice](http://reddit.com/r/cockatrice) +- [Woogerworks](http://www.woogerworks.com) / [Chickatrice] (http://www.chickatrice.net/) / [Poixen](http://www.poixen.com/) (incomplete Serverlist)
+ # Translation Status [![Cockatrice on Transiflex](https://ds0k0en9abmn1.cloudfront.net/static/charts/images/tx-logo-micro.646b0065fce6.png)](https://www.transifex.com/projects/p/cockatrice/) @@ -38,26 +34,25 @@ Language statistics for `Cockatrice` *(on the left)* and `Oracle` *(on the right [![Cockatrice translations](https://www.transifex.com/projects/p/cockatrice/resource/cockatrice/chart/image_png)](https://www.transifex.com/projects/p/cockatrice/resource/cockatrice/)      [![Oracle translations](https://www.transifex.com/projects/p/cockatrice/resource/oracle/chart/image_png)](https://www.transifex.com/projects/p/cockatrice/resource/oracle/) -Check out our [Translator FAQ](https://github.com/Cockatrice/Cockatrice/wiki/Translation-FAQ) for more information! +Check out our [Translator FAQ](https://github.com/Cockatrice/Cockatrice/wiki/Translation-FAQ) for more information!
+ # Building [![Build Status](https://travis-ci.org/Cockatrice/Cockatrice.svg?branch=master)](https://travis-ci.org/Cockatrice/Cockatrice) **Detailed compiling instructions are on the Cockatrice wiki under [Compiling Cockatrice](https://github.com/Cockatrice/Cockatrice/wiki/Compiling-Cockatrice)** Dependencies: - - [Qt](http://qt-project.org/) - [protobuf](http://code.google.com/p/protobuf/) - [CMake](http://www.cmake.org/) Oracle can optionally use zlib to load zipped files: - - [zlib](http://www.zlib.net/) The server requires an additional dependency when compiled under Qt4: - - [libgcrypt](http://www.gnu.org/software/libgcrypt/) + To compile: mkdir build @@ -75,15 +70,18 @@ The following flags can be passed to `cmake`: - `-DCMAKE_BUILD_TYPE=Debug` Compile in debug mode. Enables extra logging output, debug symbols, and much more verbose compiler warnings. - `-DUPDATE_TRANSLATIONS=1` Configure `make` to update the translation .ts files for new strings in the source code. Note: Running `make clean` will remove the .ts files. -# Building servatrice Docker container -`docker build -t servatrice .` +#### Building servatrice Docker container +`docker build -t servatrice .`
+ # Running `oracle` fetches card data `cockatrice` is the game client -`servatrice` is the server +`servatrice` is the server
+ # License -Cockatrice is free software, licensed under the GPLv2; see COPYING for details. +Cockatrice is free software, licensed under the GPLv2; see COPYING for details.
+