commit 15270f6938be93563066fb97381345d08283b773
parent 852b590567b71c66e6853a24c738a2523559e842
Author: vx-clutch <[email protected]>
Date: Thu, 8 Jan 2026 17:19:01 +0000
redo README
Diffstat:
| D | README | | | 51 | --------------------------------------------------- |
| A | README.md | | | 34 | ++++++++++++++++++++++++++++++++++ |
2 files changed, 34 insertions(+), 51 deletions(-)
diff --git a/README b/README
@@ -1,51 +0,0 @@
-+--------------+
-| yait/fSD 1.0 |
-+--------------+
-
- Highly opinionated C and SH project generator
-
- yait was written by vx-clutch
-
- Copyright Notices:
-
- yait 1.0 (c) Copyright 2025-2026 fSD.
-
- Reference the COPYING file for detailed information
-
-
-WHAT IS yait/fSD?
-
-yait/fSD 1.0 is an optionated C and SH project generator. For C project
-generation is produces a similar layout to the source of this project. On
-SH it generates a shell script with useful scaffolding for a script. For
-more detailed useage compile the program for your system and run with the
-`--help` option.
-
-
-WHAT IS NEW
-
-Features:
-
-o This is the first version, EVERYTHING is new!
-
-Bug fixes - not very interesting:
-
-o None
-
-Something is gone:
-
-o None
-
-HOW TO INSTALL yait/fSD?
-
-o UNIX: Look at estruct.h, do a 'make', test the program, 'make install'.
-
-
-ACKNOWLEDGEMENTS AND STATUS
-
-This project's file strucutre, file format, and certain contents are
-derived from uEmacs/PK 4.0 specifically from the Linux Torvalds
-distribution on GitHub. The README on from uEmacs/PK 4.0 has greater and
-more accurate attributions, if you desire.
-
-November 12, 2025
diff --git a/README.md b/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.
