From 19d7aee997b27125a04e5b0b3963bce018efcf36 Mon Sep 17 00:00:00 2001 From: PreacherDHM Date: Mon, 2 Jun 2025 17:36:20 -0700 Subject: [PATCH] Added instructions on how to build DiceRoller --- CMakeLists.txt | 2 ++ README.md | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 40 insertions(+) diff --git a/CMakeLists.txt b/CMakeLists.txt index 3ec27bf..9f6dfdd 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -9,5 +9,7 @@ set(CMAKE_COLOR_MAKEFILE ON) set(CMAKE_COLOR_DIAGNOSTICS ON) set(CMAKE_EXPORT_COMPILE_COMMANDS ON) +set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) + add_subdirectory(source) add_subdirectory(external) diff --git a/README.md b/README.md index e69de29..833dfdb 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,38 @@ +# DiceRoller +--- + +This program alows the user to make dice rols form with in the terminal. +just use the NodT format *Number of Dice Type* for example 1d20 with roll +one 20 sided die. + +## Operation +The Command *roll* with the dice that you want to ues. +```shell +$ roll 1d20 +``` +you can also run more then once set at a time. +```shell +$ roll 1d20 3d6 5d8 +``` + +## Building the Project + +To build the project it requires: + - gcc + - cmake + +First create the build directory. +```shell +$ mkdir build +``` +Then run the cmake command. +This will put all of the build files in the build directory. +```shell +$ cmake -B build . +``` +Now to build the program you can run. +This will build from the file in ./build +```shell +$ cmake --build build +``` +