Skip to content

NadzwyczajnaGrupaRobocza/bomberman

Repository files navigation

bomberman

Build StatusBuild statuscodecovCodeFactor

How To Start

1 Requirements

Beside of code You also need to install:

  • compiler that supports C++ 20
  • git
  • cmake
  • boost
  • sfml (minimum version 2.5.1)

2 Downloading and compiling code

The easiest way to get code is using git:

git clone https://github.com/NadzwyczajnaGrupaRobocza/bomberman.git

To get all external dependencies please run (this should be done only once for new repository):

git submodule init
git submodule update

You could also do this in simpler way:

git submodule update --init

Or download repository and init submodules in one step:

git clone --recurse-submodules -j <n> https://github.com/NadzwyczajnaGrupaRobocza/bomberman.git

where n is number of submodules cloned in parallel.

When You have code and all dependencies You are ready to compile. Go to bomberman directory:

cd bomberman

Inside it run cmake command, which create new directory and generate inside it files needed for compilation:

cmake . -B<build_directory>

After cmake finish creating files You can run compilation for all targets:

cmake --build <build_directory>

To compile specified target add --target flag:

cmake --build <build_directory> --target <target>

To check available targets run command:

cmake --build <build_directory> --target help

3 Running code

It's time to run code. By default cmake will put binaries in directory:

<build_directory>\bin

To check if everything wokrs fine You may run: simple-rectangle-draw (it should open window with white rectangle on black background) simple-moving-rectangle (You should see some moving white rectangles)

4 Running UTs

...