~ajpaon/squell

cff2bf0bde0221e709c47c0d68be36bdf4b08b31 — Andrew Paon 10 months ago 59f393a
Add readme with install instructions
2 files changed, 23 insertions(+), 2 deletions(-)

A README.md
M makefile
A README.md => README.md +21 -0
@@ 0,0 1,21 @@
# squell

Squell is a mashup of tetris and sudoku, inspired by [Woodoku](
https://play.google.com/store/apps/details?id=com.tripledot.woodoku&pli=1), for the terminal.

See the documentation at the top of [main.c](./main.c) for a description of how the game is implemented.

## Installation

```
# build the game
make

# install/uninstall globally
sudo make install
sudo make uninstall

# install/uninstall elsewhere
PREFIX=~/.local make install
PREFIX=~/.local make uninstall
```

M makefile => makefile +2 -2
@@ 3,7 3,7 @@ CC=clang
PREFIX?=/usr/local
BINDIR=$(PREFIX)/bin

all: squell
all: release

debug: CFLAGS=-Wall --debug
debug: squell


@@ 19,7 19,7 @@ clean:
	rm -f *.o squell

.PHONY: install
install: release
install:
	install squell $(BINDIR)

.PHONY: uninstall