From: Ryan Liptak <squeek502@hotmail.com>
Date: Fri, 29 May 2020 00:09:45 +0000 (-0700)
Subject: Add license + readme
X-Git-Tag: v0.1.0
X-Git-Url: https://git.lizzy.rs/?a=commitdiff_plain;h=765baabce76ee76dad14363df6401194fa24864b;p=micro-zigfmt.git

Add license + readme
---

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..00d2e13
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..697d1b4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+micro-zigfmt
+============
+
+Plugin for the [micro editor](https://github.com/zyedidia/micro) that provides support for:
+
+- `zig fmt` on save
+- `zig fmt --check` integration with the official linter plugin
+
+## Installation
+
+Install by cloning this into your plug directory:
+
+```
+git clone https://github.com/squeek502/micro-zigfmt ~/.config/micro/plug/zigfmt
+```
+
+## Usage
+
+See [the help file](help/zigfmt.md)
+
+Or, after installation, from within micro:
+
+```
+> help zigfmt
+```