From d0d9989b1da041c64f5b97ee620ed1aeb2d4758e Mon Sep 17 00:00:00 2001 From: Kestrel Gregorich-Trevor Date: Thu, 18 Jan 2024 09:33:44 -0600 Subject: [PATCH] Update README.md. --- .github/workflows/release.yml | 2 +- README.md | 9 ++++----- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 8a884dd..ea2171c 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -47,7 +47,7 @@ jobs: - name: Create Package run: | - zip -r ${{github.workspace}}/zenzizenzizenzic-${{ runner.os }} build/zenzizenzizenzic_ncurses build/data/ README.md LICENSE + zip -r -db ${{github.workspace}}/zenzizenzizenzic-${{ runner.os }} build/zenzizenzizenzic_ncurses build/data/ README.md LICENSE - name: Upload Release uses: softprops/action-gh-release@v1 diff --git a/README.md b/README.md index 1e31ce4..de97df7 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # Zenzizenzizenzic ![Release Status](https://github.com/NullCGT/Zenzizenzizenzic-RL/actions/workflows/cmake-single-platform.yml/badge.svg) -![Release Status](https://github.com/NullCGT/Zenzizenzizenzic-RL/actions/workflows/release.yml/badge.svg?branch=main) A traditional roguelike with mechanics that mimic those found in fighting games. @@ -25,17 +24,17 @@ This is a console-based roguelike written in plain C. A moldering potato can pro - Ncurses +To download the game, find the latest [release](https://github.com/NullCGT/Zenzizenzizenzic-RL/releases). Download the version that corresponds to your operationg system and unzip it to a new folder. Launch the game in the build directory. + ## Building from Source -Zenzizenzizenzic is built using CMake. +Zenzizenzizenzic is built using CMake. In order to compile the game for local testing, run the following commands: ``` -mkdir build cmake --preset=dev cmake --build build ``` -The game binary and necessary data files will appear in the newly-created build -directory. +The game binary and necessary data files will appear in the newly-created build directory. In order to compile the game with release-level compiler optimizations, replace "dev" with "release." Note that this will disable most compiler warnings and debug hooks. ## FAQ