Skip to content

Commit

Permalink
chore: README
Browse files Browse the repository at this point in the history
  • Loading branch information
ary82 committed Aug 22, 2024
1 parent d9b9df1 commit 7288c90
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ all: build-tui build-ssh

build-tui:
@echo "building tui binary..."
@go build -o tui-bin cmd/tui/main.go
@go build -o tui-bin cmd/pacman-tui/main.go

run-tui: build-tui
@echo "running tui binary..."
Expand Down
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,28 @@
pacman tui app made with [bubbletea](https://github.com/charmbracelet/bubbletea) and other [charm.sh](https://charm.sh) libraries

made for trying out charm.sh libraries and elm-like architectures

## Run

You can either build and run the binary for the game:

```bash
make run-tui
```

Or, build and run the ssh server for the game and ssh into it:

```bash
# Using the script
PORT=8080 make run-ssh

# Or with docker
docker run --rm -it -p 8080:8080 -e PORT=8080 ghcr.io/ary82/pacman:main

# ssh into the game
ssh ssh://0.0.0.0:8080
```

<p align="center">
<img alt="screenshot of the game" src="./docs/screenshot.png">
</p>
Binary file added docs/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7288c90

Please sign in to comment.