oakamoore/terminal-rain

A terminal based rain visualisation

terminal-rain

Overview

A terminal based rain visualisation, inspired by nkleemann's implementation in C.

Installation

1. Clone this project

git clone https://github.com/Oakamoore/terminal-rain.git

2. Step into the repository

cd terminal-rain

3. Build the project using CMake

# Configure the build
cmake -S . -B build

# Build project binaries 
cmake --build build

Specifying a Build Configuration

Depending on the type of CMake generator being used, a build configuration (Debug, Release etc.) can be specified as follows:

Single Configuration Generator

# Configure a release build
cmake -S . -B build -D CMAKE_BUILD_TYPE=Release

# Build release binaries
cmake --build build

Multi-Configuration Generator

# Configure the build
cmake -S . -B build 

# Build release binaries
cmake --build build --config Release

Disabling Testing

To prevent tests from being built, append -D ENABLE_TESTING=0 to the build configuration command.

Usage

Once the project is built, navigate to the newly created terminal-rain/build/ directory, locate the executable, then run the program using:

./terminal-rain

Press Escape or q while the program is running to quit.

Testing

Once the project is built, navigate to terminal-rain/build/tests/, locate the testing executable, then run the tests using:

./terminal-rain-tests

Notes

To function as expected, this program requires a terminal emulator that supports a 16-color palette and ANSI escape codes.