Skip to content

Commit 32794f3

Browse files
committed
Update README.md
1 parent 38f9c8c commit 32794f3

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
11
![screenshot](/screenshots/2024-06-24.png)
22

3+
# Install
4+
5+
This game can be installed by using make:
6+
7+
```sh
8+
make install
9+
```
10+
11+
Make will put the game files in `/usr/local/cpp-opengl` by default, and create a wrapper script to load shaders and textures.
12+
This can be changed with the `PREFIX` environment variable.
13+
14+
Nix can also be used to run the project straight from the repo:
15+
16+
```sh
17+
nix run github:joinemm/cpp-opengl
18+
```
19+
20+
# Develop
21+
322
## Dependencies
423

524
- [GLFW](https://github.com/glfw/glfw)
@@ -38,4 +57,11 @@ make run
3857
make clean
3958
```
4059

41-
The compiled binary can be found at `./bin/out`
60+
The compiled binary can be found at `./game`
61+
62+
Nix can also be used to for building:
63+
64+
```sh
65+
nix build
66+
cd result
67+
```

0 commit comments

Comments
 (0)