Skip to content

Commit

Permalink
Update README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
Kestrel Gregorich-Trevor committed Jan 18, 2024
1 parent 12a50bd commit d0d9989
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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

Expand Down

0 comments on commit d0d9989

Please sign in to comment.