redo README

README.md

@@ -0,0 +1,34 @@
+# yait
+
+https://fsd.vxserver.dev/releases/yait
+
+Get your project started:
+
+- A full C or SH project template
+- Extensible file templating
+    * via ~/.local/share/yait/templates
+
+## Install
+
+#### Dependencies
+
+- `shellcheck` - lint shell scripts **development dependency**
+
+**Note**: `shellcheck` is used as a pre-commit git hook to for quality
+assurance purposes. This does not invalidate our COPYING policy. This software
+still should be used at your own risk without an warranty
+
+```bash
+git clone https://git.vxserver.dev/fSD/yait
+cd yait
+sudo make install
+```
+
+## Usage
+
+This tool runs via the command `yait`.
+
+- `yait -x c`   -- Create a C project.
+- `yait -x sh`  -- Create a SH project.
+- `yait -S ...` -- Create a single/small project.
+- `yait -f`     -- Overwrite existing files.