Skip to content

Commit eff409b

Browse files
committed
Update README.md: Correct typo and enhance binary download instructions for Linux and Windows
1 parent 036c60e commit eff409b

1 file changed

Lines changed: 28 additions & 21 deletions

File tree

README.md

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
**restoHack** is a full-blooded resurrection of *Hack*, the 1984 roguelike that spawned *NetHack*.
44
Not a remake. Not a reboot. This is *software preservation with a blowtorch and a scalpel*.
55

6-
The goal: make the original code compile, run, and dungeon-crawl exactly as it did when floppy was King.
6+
The goal: make the original code compile, run, and dungeon-crawl exactly as it did when floppies were king.
77

88
Think resto-mod: the soul stays vintage, the internals get a precision rebuild.
99

@@ -41,17 +41,13 @@ Think resto-mod: the soul stays vintage, the internals get a precision rebuild.
4141
4242
---
4343

44-
**Recognition:**
44+
**Recognition:**
4545
RestoHack was recognized by **GitHub** as a *For the Love of Code* category winner (2025).
4646
Featured in the official GitHub Blog:
4747
[From Karaoke Terminals to AI Resumes — The Winners of GitHub’s For the Love of Code Challenge](https://github.blog/open-source/from-karaoke-terminals-to-ai-resumes-the-winners-of-githubs-for-the-love-of-code-challenge/)
4848

4949
---
5050

51-
**Development Status:**
52-
After a brief pause, active development is gearing back up. The upcoming work will focus heavily on strengthening safety guards throughout the codebase and continuing the long-term mission of cleaning up undefined behavior while keeping the original 1984
53-
spirit intact.
54-
5551
## Play Online (Hardfought)
5652

5753
restoHack is now available on [Hardfought](https://www.hardfought.org/) — no installation required.
@@ -76,7 +72,24 @@ Hardfought also lets you watch games in progress (`w` from the main menu).
7672
yay -S restohack
7773
```
7874

79-
## Build from Source (Pre-release)
75+
### Download Pre-built Binary (Linux)
76+
77+
Download the static binary from [Releases](https://github.com/Critlist/restoHack/releases):
78+
79+
```bash
80+
mkdir -p ~/Games/restohack
81+
cd ~/Games/restohack
82+
tar -xzf restoHack-*-linux-x86_64-static.tar.gz
83+
./run-hack.sh
84+
```
85+
86+
*Note: As of v1.1.1, we provide separate binary and source tarballs instead of hybrid packages.*
87+
88+
*(static binary, no dependencies required)*
89+
90+
Also available on [itch.io](https://critlist.itch.io/restohack) — no compiling required.
91+
92+
### Build from Source
8093

8194
**Requirements:** `git`, `cmake`, a C compiler, `ncurses`
8295

@@ -94,24 +107,18 @@ cd build && ./hack
94107
cmake --preset=release && cmake --build build
95108
```
96109

97-
---
98-
99-
### Download Pre-built Binary (Linux)
100-
101-
Download the static binary from [Releases](https://github.com/Critlist/restoHack/releases):
110+
**For BSD systems, development builds, IDE integration, and troubleshooting:** see [**Build Instructions**](docs/BUILD.md)
102111

103-
```bash
104-
mkdir -p ~/Games/restohack
105-
cd ~/Games/restohack
106-
tar -xzf restoHack-*-linux-x86_64-static.tar.gz
107-
./run-hack.sh
108-
```
112+
### Windows (Work in Progress)
109113

110-
*Note: As of v1.1.1, we provide separate binary and source tarballs instead of hybrid packages.*
114+
A `windows-port` branch exists targeting **MSVC** and **MinGW64** using **PDCurses**.
111115

112-
*(static binary, no dependencies required)*
116+
The MinGW build currently compiles but is **not yet playable**. Build system
117+
details and testing are still in progress.
113118

114-
**For BSD systems, development builds, IDE integration, and troubleshooting:** see [**Build Instructions**](docs/BUILD.md)
119+
The long-term goal is a simple Windows build so people curious about early
120+
roguelike and Hack history can experience the game without needing a Unix
121+
terminal. A free Steam release is planned once the Windows build is stable.
115122

116123
---
117124

0 commit comments

Comments
 (0)