README.md

   1 micro-zigfmt
   2 ============
   3
   4 Plugin for the [micro editor](https://github.com/zyedidia/micro) that provides support for:
   5
   6 - `zig fmt` on save
   7 - `zig fmt --check` integration with the official linter plugin
   8
   9 for [Zig](https://github.com/ziglang/zig) files.
  10
  11 ## Installation
  12
  13 Using the plugin manager:
  14
  15 ```
  16 micro -plugin install zigfmt
  17 ```
  18
  19 Or from within micro (must restart micro afterwards for the plugin to be loaded):
  20
  21 ```
  22 > plugin install zigfmt
  23 ```
  24
  25 Or manually install by cloning this repo as `zigfmt` into your `plug` directory:
  26
  27 ```
  28 git clone https://github.com/squeek502/micro-zigfmt ~/.config/micro/plug/zigfmt
  29 ```
  30
  31 ## Usage
  32
  33 See [the help file](help/zigfmt.md)
  34
  35 Or, after installation, from within micro:
  36
  37 ```
  38 > help zigfmt
  39 ```