teutat3s/tritonshell
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Improve Readme

Browse source
This commit is contained in:
jhonas 2022-03-03 11:49:00 +01:00
parent f5d8100d91
commit 89c7c337d2
Signed by: teutat3s
GPG key ID: 924889A86D0B0FEB
1 changed files with 11 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -3,8 +3,8 @@
[![asciicast](https://asciinema.org/a/pIGfe11qb3r33WstkkFW7BSuF.svg)](https://asciinema.org/a/pIGfe11qb3r33WstkkFW7BSuF) [![asciicast](https://asciinema.org/a/pIGfe11qb3r33WstkkFW7BSuF.svg)](https://asciinema.org/a/pIGfe11qb3r33WstkkFW7BSuF)
0. If you're already on NixOS and / or have worked with `flakes` before, jump to **2.** 0. If you're already on NixOS and / or have worked with `flakes` before, **jump** to **2.**
1. [Install nix, the package manager](https://nixos.org/download.html) 1. [**Install** nix, the package manager](https://nixos.org/download.html)
1. Now, make sure you're ready to `nix` with flakes, this should give you 1. Now, make sure you're ready to `nix` with flakes, this should give you
some output: some output:
@ -15,28 +15,30 @@
`nix`): `nix`):
https://nixos.wiki/wiki/Flakes#Installing_flakes https://nixos.wiki/wiki/Flakes#Installing_flakes
2. Get this nix flake template, it will be setup in a new directory 2. **Get** this nix flake template, it will be setup in a new directory
`./tritonshell` (feel free to adjust this): `./tritonshell` (feel free to adjust this):
``` ```
nix flake new --template "git+https://git.greenbaum.cloud/dev/tritonshell?ref=main" ./tritonshell nix flake new --template "git+https://git.greenbaum.cloud/dev/tritonshell?ref=main" ./tritonshell \
cd tritonshell && cd tritonshell
``` ```
3. Adjust `./flake.nix` to match domains and data centers of your Triton Data 3. **Optional**: **Adjust** `./flake.nix` to match domains and data centers of your Triton Data
Center setup. Look for the `CUSTOMIZE` comment. Greenbaum Cloud users skip Center setup. Look for the `CUSTOMIZE` comment.
Greenbaum Cloud users skip
this step, everything's preconfigured. this step, everything's preconfigured.
``` ```
vim ./flake.nix vim ./flake.nix
``` ```
4. Ready to go: 4. **Ready** to go:
``` ```
nix develop nix develop
``` ```
**Optional**: **Optional**:
If you'd like to customize your new tritonshell with additional packages, you If you'd like to add **additional packages** to your new tritonshell, you
can do so: just edit `flake.nix` and look for `extraDevshellPkgs`. Packages can do so: just edit `flake.nix` and look for `extraDevshellPkgs`. Packages
added here will be pulled from the `nixos-unstable` channel, you can [search added here will be pulled from the `nixos-unstable` channel, you can [search
for available packages here](https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=hello). for available packages here](https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=hello).