From 54534cad02c7a575ca26833c671be04f261e9fbb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Madeleine=20Sydney=20=C5=9Alaga?= <msyds@deertopia.net>
Date: Wed, 13 Aug 2025 17:14:05 -0600
Subject: [PATCH] feat: readme

---
 README.md   | 33 +++++++++++++++++++++++++++++++++
 package.nix |  2 +-
 2 files changed, 34 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 7958754..259de12 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,36 @@ My personal Fcitx5 input tables.
 The CMake code was nabbed directly from https://github.com/fcitx/fcitx5-table-other.
 
 - The sydmath table is based on [agda-input](https://github.com/agda/agda/blob/7bc882012789200911852f5e4045150be2604b42/src/data/emacs-mode/agda-input.el) and [fcitx5-table-other's LaTeX table](https://github.com/fcitx/fcitx5-table-other/blob/master/tables/other/latex.txt)
+
+## Install
+
+### Without Nix
+
+... 
+
+### With Nix
+
+I intend to set up a flake soonish.  For now, this can be installed into your
+NixOS/Home-manager configs with the following snippet:
+
+```nix
+i18n.inputMethod = {
+  enable = true;
+  type = "fcitx5";
+  fcitx5 = {
+    addons = [
+      # The package `fcitx5-chinese-addons` is *required*!!
+      # See https://github.com/NixOS/nixpkgs/issues/126748.
+      pkgs.libsForQt5.fcitx5-chinese-addons
+      (let
+        repo = pkgs.fetchgit {
+          url = "https://gitlab.com/msyds/syd-fcitx5-tables";
+          tag = "v1.1.0";
+          hash = "sha256-Ndm+XUMFmkcrVH9tLvyiXP4gvShx3ELrURYdp2KfOyQ=";
+        };
+      in pkgs.callPackage "${repo}/package.nix" {})
+    ];
+  };
+};
+```
+
diff --git a/package.nix b/package.nix
index b254dd5..6358e3d 100644
--- a/package.nix
+++ b/package.nix
@@ -32,7 +32,7 @@ stdenv.mkDerivation rec {
   ];
 
   meta = with lib; {
-    description = "Madeleine's Fcitx tables";
+    description = "Madeleine's Fcitx5 tables";
     license = licenses.gpl3Only;
     platforms = platforms.linux;
   };