diff --git a/README.md b/README.md new file mode 100644 index 00000000..3502fd8a --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# 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 4. + +# License + +Cockatrice is free software, licensed under the GPLv2; see COPYING for details. + +# Building + +Dependencies: + +- [Qt](http://qt-project.org/) + +- [protobuf](http://code.google.com/p/protobuf/) + +- [CMake](http://www.cmake.org/) + +The server requires an additional dependency: + +- [libgcrypt](http://www.gnu.org/software/libgcrypt/) + +``` +mkdir build +cd build +cmake .. +make +make install +``` + +The following flags can be passed to `cmake`: + +- `-DWITH_SERVER=1` build the server + +- `-DWITHOUT_CLIENT=1` do not build the client + +# Running + +`oracle` fetches card data + +`cockatrice` is the game client + +`servatrice` is the server