From 864fb5fd366c4eaaa4fd74f1647d5d47e456e6fa Mon Sep 17 00:00:00 2001 From: James Campos Date: Tue, 29 Jan 2013 13:15:06 -0800 Subject: [PATCH 1/3] Create README.md --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..6630895f --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# 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/) + +``` +mkdir build +cd build +cmake .. +make +make install +``` From 72b60026f7aec16852c491ee8ad41f1a87b5f068 Mon Sep 17 00:00:00 2001 From: James Campos Date: Tue, 29 Jan 2013 13:34:37 -0800 Subject: [PATCH 2/3] server --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 6630895f..e167000c 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,10 @@ Dependencies: - [CMake](http://www.cmake.org/) +The server requires an additional dependency: + +- [libgcrypt](http://www.gnu.org/software/libgcrypt/) + ``` mkdir build cd build @@ -26,3 +30,9 @@ 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 From 488726f9a697c13bb76be43ed51d6b11169d6854 Mon Sep 17 00:00:00 2001 From: James Campos Date: Tue, 29 Jan 2013 13:47:54 -0800 Subject: [PATCH 3/3] Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index e167000c..3502fd8a 100644 --- a/README.md +++ b/README.md @@ -36,3 +36,11 @@ 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