initial

README.md

@@ -0,0 +1,46 @@
+# Description
+
+set of nixos modules to set better (opinionated) defaults
+
+# Usage
+
+You could clone this repo into /etc/nixos and add a submodule.
+Or, add it as a flake input.
+
+```nix
+# This enables many of the defaults from this repository
+nixowos.enable = true;
+
+# extra switches
+
+# enables the default set of graphical settings.
+# for instance if plasma6 is enabled, enable kdeconnect too
+nixowos.graphical.enable = true;
+
+# enables steam with relevant ports opened,
+# enables mangohud with a nice default config,
+# and loads ntsync kernel module for (possibly) better performance
+nixowos.graphical.games.enable = true;
+
+# only if you have an nvidia card, of course
+nixowos.graphical.nvidia.enable = true;
+
+# installs better asian fonts,
+# and sets up fcitx for japanese input
+# (toggle with ctrl+alt+space)
+nixowos.graphical.jp.enable = true;
+
+# instead of using sddm, use a tiny script on login
+# to run startplasma_wayland if running on /dev/tty1
+# note: this doesn't automatically unlock kwallet
+nixowos.plasma.startOnFirstTTY = true;
+```
+
+Many of the extra settings can be added to or overridden.
+
+```nix
+# this would replace the default config with a single setting,
+# to only extract (save) audio.
+# not recommended for a global config for obvious reasons.
+nixowos.cli.yt-dlp.extraConfig = "--extract-audio";
+```