aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: dcafcebc8710c761e43375e20d6bf9e9b0a6f8cd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# Shell Game Launcher

Shell Game Launcher is a modern dgamelaunch alternative. It is a network based shell where anyone can sign up for an account and start playing any game hosted there. Nethack is the main target audience, but any shell game should be able to be hosted this way.

## Content

- [Dependencies](#dependencies)
- [Building](#building)
- [Usage](#usage)

## Dependencies

go is required. Only go version >= 1.15.6 on linux amd64 (Gentoo and Ubuntu 20.04) and on OpenBSD amd64 has been tested.

## Building

To run tests, use :
```
go test -cover ./...
```

For a debug build, use :
```
go build
```

For a release build, use :
```
go build -ldflags="-s -w"
```

## Usage

TODO