]> git.lizzy.rs Git - micro-zigfmt.git/blob - README.md
readme: Update install instructions
[micro-zigfmt.git] / 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 > plugin install zigfmt
17 ```
18
19 Or manually install by cloning this repo as `zigfmt` into your `plug` directory:
20
21 ```
22 git clone https://github.com/squeek502/micro-zigfmt ~/.config/micro/plug/zigfmt
23 ```
24
25 ## Usage
26
27 See [the help file](help/zigfmt.md)
28
29 Or, after installation, from within micro:
30
31 ```
32 > help zigfmt
33 ```