From e9405b69e7ed9ffbc5d8ac3919ac22cbed0131df Mon Sep 17 00:00:00 2001 From: Aadhavan Srinivasan Date: Sat, 9 Mar 2024 12:46:52 -0500 Subject: [PATCH] Updated README --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 773255e..cb1052f 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,21 @@ __Netpong__ is a network-enabled Pong game, written in C++. It enables two playe ## How it works -The game has only one runtime dependency: The [raylib](https://www.raylib.com/) graphics system. In order to write idiomatic C++, I chose to use the [raylib-cpp](https://robloach.github.io/raylib-cpp/) wrapper, which provides an object-oriented interface to the Raylib library. However, this wrapper is bundled with the project, and is thus not required to be installed. +The game has only one runtime dependency: The [raylib](https://www.raylib.com/) graphics library. In order to write idiomatic C++, I chose to use the [raylib-cpp](https://robloach.github.io/raylib-cpp/) wrapper, which provides an object-oriented interface to the Raylib library. ## Building This application uses [Meson](https://mesonbuild.com/) as a build system. To build the application: 1. Install __meson__ from the link above. -2. Install __raylib__ from the link above (THIS IS OPTIONAL, SEE STEP 5) -3. Set up the build directory with the `meson setup build` command. -4. Compile the application, with the existing raylib installation, using `meson compile -C build`. -5. If you don't have raylib installed, you can create a statically linked version of the library on Linux by running the following commands: +2. Set up the build directory. + ``` + meson setup build + ``` +3. Compile the application. Meson should use a system installation of raylib, if it exists. If not, it falls back to a bundled version. + ``` + meson compile -C build + ``` +4. You can also create a statically-linked version of the game (with no runtime dependencies) on Linux by running the following commands: ``` meson configure -Ddefault_library=static build/ @@ -30,3 +35,7 @@ This application uses [Meson](https://mesonbuild.com/) as a build system. To bui - One player runs the application in Server mode, specifying their IP address and a port: `build/pong -S ` - The other player connects to the first player by running in Client mode, specifying the first player's IP address and port: `build/pong -C `. - The server controls the left paddle by default (WIP to allow the user to modify this), and the client controls the right paddle. + +## TODO + +See todo.txt.