From 51cdc66c48b3d0d19ea71fdcc2ed3f5378d031fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Madeleine=20Sydney=20=C5=9Alaga?= Date: Thu, 5 Mar 2026 18:34:15 -0700 Subject: [PATCH] chore: readme --- README.org | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/README.org b/README.org index 600be23..334fe3b 100644 --- a/README.org +++ b/README.org @@ -7,19 +7,19 @@ For the practical purposes including easy deployment and version-tracking, as we * 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. 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. -* 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]]: @@ -37,10 +37,7 @@ tf2-nix is dead simple. No modules of any variety are provided (at this point in ** TL;DR -*** As a flake - Bring in the input, and build your TF2 config as a package: - #+begin_src nix { inputs = { @@ -78,9 +75,7 @@ Bring in the input, and build your TF2 config as a package: }; } #+end_src - You can then install your configuration into TF2's =tf= directory: - #+begin_src nix ### home.nix let @@ -93,17 +88,14 @@ You can then install your configuration into TF2's =tf= directory: }; } #+end_src - Rebuild your system, and rejoice! ** Example Flake Try out the example flake: - #+begin_example $ nix build 'gitlab:msyds/tf2-nix?dir=example' #+end_example - The resulting config can then be explored in =./result/=. ** Library