From 341ba075234b59da1349a1572331c5d18cd93939 Mon Sep 17 00:00:00 2001 From: Johannes Leupolz Date: Wed, 6 May 2026 20:19:07 +0000 Subject: [PATCH] Remark on NixOS --- README.md | 5 +++-- docs/USAGE-NIXOS.md | 13 +++++++++++++ 2 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 docs/USAGE-NIXOS.md diff --git a/README.md b/README.md index f37d734..af96208 100644 --- a/README.md +++ b/README.md @@ -77,8 +77,9 @@ sequenceDiagram ## Documentation See [docs/BUILD.md](https://github.com/joleuger/vuinputd/blob/main/docs/BUILD.md) for a short build and installation guide. -See [docs/DESIGN.md](https://github.com/joleuger/vuinputd/blob/main/docs/DESIGN.md) for a detailed overview of the architecture, design trade-offs, and security considerations. -See [docs/USAGE.md](https://github.com/joleuger/vuinputd/blob/main/docs/USAGE.md) for a short usage guide. +See [docs/DESIGN.md](https://github.com/joleuger/vuinputd/blob/main/docs/DESIGN.md) for a detailed overview of the architecture, design trade-offs, and security considerations. +See [docs/USAGE.md](https://github.com/joleuger/vuinputd/blob/main/docs/USAGE.md) for a short usage guide. +See [docs/USAGE-NIXOS.md](https://github.com/joleuger/vuinputd/blob/main/docs/USAGE-NIXOS.md) for a short usage guide for NixOS. See [docs/DEBUG.md](https://github.com/joleuger/vuinputd/blob/main/docs/DEBUG.md) for a guide how to debug problems with containers. --- diff --git a/docs/USAGE-NIXOS.md b/docs/USAGE-NIXOS.md new file mode 100644 index 0000000..c8408c8 --- /dev/null +++ b/docs/USAGE-NIXOS.md @@ -0,0 +1,13 @@ +# Usage Guide for NixOS + +This guide will explain how to use `vuinputd` on NixOS. For general remarks, please refer to [USAGE.md](USAGE.md). + +Currently, this is WIP. The plan is to make NixOS one of the main platforms for vuinputd. +--- + +## Configurations in the community + +* [ShaneTRS](https://github.com/ShaneTRS/nixos-config/) +* [griffi-gh](https://github.com/girl-pp-ua/nixos-infra/) + +Feel free to create a github issue or a PR to add your configuration or your remarks. \ No newline at end of file