initial version

Signed-off-by: czjstmax <jstmaxlol@disroot.org>

1 files changed, 15 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..651875a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# czuki
+a modified version of [azuki_font](https://azukifont.com/) with latin-ized backslash, a few simple extra glyphs and some minor changes to other glyphs.
+
+## installation
+###### (!) to install czuki you must either generate it yourself with [fontforge]() or use the pre-generated version found in `exported/czuki.ttf`
+1. run the patcher (`./patch` or `python ./patch`)
+2. run the installer (`./install`) or copy the patched font (`patched/czuki.ttf`) in your fonts directory manually
+
+## notes
+similarily to azuki_font, in some specific terminal emulators like [kitty](), you will have to change the cell-size manually, in kitty you can do that by adding the following line to your config:
+```
+modify_font cell_width 45%
+```
+in this specific case i set the `cell_width` to `45%` because i found that to look good enough for me, though you can change it howerver you want. (_i dont recommend going under 40%_)
+