msyds/tf2-nix
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

chore: readme

Browse Source
This commit is contained in:
Madeleine Sydney Slaga
2026-03-05 18:34:15 -07:00
parent 3afc3e370b
commit 51cdc66c48
1 changed files with 4 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.org
View File

@@ -7,19 +7,19 @@ For the practical purposes including easy deployment and version-tracking, as we
* Disclaimers * Disclaimers
** This is an alpha status project ** This is a young project
At the moment, this project should mostly be considered a proof of concept. It is usable, I am using it, but it is pretty bare-bones. I hope to gradually expand this project anon. More packages, modules, all the Nix goodness we're accustomed to. At the moment, this project should mostly be considered a proof of concept. It is usable, I am using it, but it is pretty bare-bones. I hope to gradually expand this project anon. More packages, modules, all the Nix goodness we're accustomed to.
Further, I'm not the most experienced Nix user. Expect bad code and unidiomatic interfaces. I encourage you to point out said bad code if you spot it. }:) Further, I'm not the most experienced Nix user. Expect bad code and unidiomatic interfaces. I encourage you to point out said bad code if you spot it. }:)
** TF2 is a radioactive zigzagging target ** TF2 is an unpredictable target
In my experience, TF2 and Valve software in general [[https://github.com/DeerUwU/deerhud-tf2/pull/15][react]] [[https://github.com/flathub/com.valvesoftware.Steam/issues/1218][very]] [[https://github.com/nix-community/impermanence/issues/165#issuecomment-2529954063][dramatically]][fn:2][fn:3] when prodded with even slightly unorthodox setups. Brace yourself before updating TF2, and never be afraid to open an issue here. In my experience, TF2 and Valve software in general [[https://github.com/DeerUwU/deerhud-tf2/pull/15][react]] [[https://github.com/flathub/com.valvesoftware.Steam/issues/1218][very]] [[https://github.com/nix-community/impermanence/issues/165#issuecomment-2529954063][dramatically]][fn:2][fn:3] when prodded with even slightly unorthodox setups. Brace yourself before updating TF2, and never be afraid to open an issue here.
* FAQ (Frequently-anticipated questions) * FAQ (a Few Anticipated Questions)
** How make [[https://github.com/nix-community/impermanence][Impermanence]] work? ** How to make [[https://github.com/nix-community/impermanence][Impermanence]] work?
See [[https://github.com/nix-community/impermanence/issues/165#issuecomment-2537723929][nix-community/impermanence#165]]: See [[https://github.com/nix-community/impermanence/issues/165#issuecomment-2537723929][nix-community/impermanence#165]]:
@@ -37,10 +37,7 @@ tf2-nix is dead simple. No modules of any variety are provided (at this point in
** TL;DR ** TL;DR
*** As a flake
Bring in the input, and build your TF2 config as a package: Bring in the input, and build your TF2 config as a package:
#+begin_src nix #+begin_src nix
{ {
inputs = { inputs = {
@@ -78,9 +75,7 @@ Bring in the input, and build your TF2 config as a package:
}; };
} }
#+end_src #+end_src
You can then install your configuration into TF2's =tf= directory: You can then install your configuration into TF2's =tf= directory:
#+begin_src nix #+begin_src nix
### home.nix ### home.nix
let let
@@ -93,17 +88,14 @@ You can then install your configuration into TF2's =tf= directory:
}; };
} }
#+end_src #+end_src
Rebuild your system, and rejoice! Rebuild your system, and rejoice!
** Example Flake ** Example Flake
Try out the example flake: Try out the example flake:
#+begin_example #+begin_example
$ nix build 'gitlab:msyds/tf2-nix?dir=example' $ nix build 'gitlab:msyds/tf2-nix?dir=example'
#+end_example #+end_example
The resulting config can then be explored in =./result/=. The resulting config can then be explored in =./result/=.
** Library ** Library