update

README.md

@@ -1 +1,22 @@
-# Report Template
+# Report Template + Custom Vim Nix Flake
+
+This templates are designed to be able to summon with single Nix command.
+
+This flake includes three templates, two devShells, and two packages.
+
+## Templates
+
+* `latex` - "Generic" LaTeX report, customized for my Kosen
+* `pandoc` - Single file markdown report, pandoc for LaTeX/PDF output
+* `pandoc-multi` - Same as `pandoc`, but configured for multi file
+
+## DevShells
+
+* `latex` - The default devShell, includes custom TeX environment and pre-configured vim
+* `pandoc` - pandoc with custom TeX environment
+
+## Packages
+
+* `texEnv` - Custom TeX environment with packages, fonts, and tools all in one
+* `vimWithTeX` - Pre-configured vim with `vim-eskk` as in-place Japanese input method and `vim-tex` for TeX support
+