yait

Yet Another Init Tool
Log | Files | Refs | README | LICENSE

README.md (820B)

      1 # yait
      2 
      3 https://fsd.vxserver.dev/releases/yait
      4 
      5 Get your project started:
      6 
      7 - A full C or SH project template
      8 - Extensible file templating
      9     * via ~/.local/share/yait/templates
     10 
     11 ## Install
     12 
     13 #### Dependencies
     14 
     15 - `git` - source control tool
     16 - `shellcheck` - lint shell scripts **development dependency**
     17 
     18 **Note**: `shellcheck` is used as a pre-commit git hook to for quality
     19 assurance purposes. This does not invalidate our COPYING policy. This software
     20 still should be used at your own risk without an warranty
     21 
     22 ```bash
     23 git clone https://git.vxserver.dev/fSD/yait
     24 cd yait
     25 sudo make install
     26 ```
     27 
     28 ## Usage
     29 
     30 This tool runs via the command `yait`.
     31 
     32 - `yait -x c`   -- Create a C project.
     33 - `yait -x sh`  -- Create a SH project.
     34 - `yait -S ...` -- Create a single/small project.
     35 - `yait -f`     -- Overwrite existing files.