bettola/README.org

40 lines
988 B
Org Mode

#+TITLE: Bettola Game
A 2D RPG game and engine created with C++, SDL3, and OpenGL.
* Dependencies
The following dependencies are requird:
- A C++ compiler (e.g., clang, g++)
- CMake (3.16 or newer)
- SDL3 development libraries
- GLEW development libraries
** Installation (Debian)
You can install all required dependencies with the following command:
#+BEGIN_SRC bash
sudo apt update
sudo apt install build-essential clang cmake libsdl3-dev libglew-dev
#+END_SRC
* Build Instructions
This project uses a top-level Makefile to simplify the CMake workflow. All build artifacts will be placed in the =bin/= directory.
Run the following from the root of the project directory.
- *Build the project:*
The executable will be located in =bin/bettola=.
#+BEGIN_SRC bash
make
#+END_SRC
- *Build and run the project:*
#+BEGIN_SRC bash
make run
#+END_SRC
- *Clean the project:*
This removes the =bin/= directory.
#+BEGIN_SRC bash
make clean
#+END_SRC