Skip to content

Commit c617f4c

Browse files
committed
readme: fix instructions to describe actual installation, not a mere build
1 parent 90ac7e6 commit c617f4c

1 file changed

Lines changed: 18 additions & 3 deletions

File tree

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ sudo apt-get install build-essential pkg-config cmake libx11-dev \
1616
freeglut3-dev qt5-default libqt5x11extras5-dev git \
1717
libsdl2-gfx-dev libsdl2-image-dev libsdl2-ttf-dev libjpeg-turbo8-dev
1818
```
19-
.. or using Nix, for which keep reading.
19+
> .. or using Nix, for which keep reading.
2020
2121
### Get Source and Build ###
2222

@@ -38,12 +38,27 @@ There are two build methods, due to development environment setup mechanisms: Ni
3838

3939
##### Linux (Mac OS X untested, but not impossible) ####
4040

41-
There are two options:
41+
First, you need to have Nix installed (citing http://nixos.org/nix/manual/#ch-installing-binary):
42+
43+
```
44+
bash <(curl https://nixos.org/nix/install)
45+
```
46+
..which, upon success, can be validated with:
47+
48+
```
49+
nix-env --query --installed # ..which should list just `nix`, initially.
50+
```
51+
52+
> NOTE: If security implications of this particular step worry you, please read
53+
> the following piece by Domen Kožar:
54+
> https://www.domenkozar.com/2015/09/27/friends-sometimes-let-friends-curl-to-shell/)
55+
56+
Once that's behind us, the following two options become available:
4257

4358
1. Building and installing the package into the current user environment:
4459

4560
```
46-
desktop@steamos:~/src/vogl$ nix-build --cores 8 shell.nix
61+
desktop@steamos:~/src/vogl$ nix-env --no-build-output --cores 0 -iE 'f: (import ./shell.nix {})'
4762
these derivations will be built:
4863
/nix/store/zvdz4dhprf6kbnjf5sjcc8731rnbmd1z-vogl-2016-05-13.drv
4964
building path(s) ‘/nix/store/b88a5flgwjghw204wg5j8ahqs50l2qba-vogl-2016-05-13’

0 commit comments

Comments
 (0)