basic information

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Raphael Vogelgsang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

README.md

@@ -1 +1,40 @@
 # NeoTex
+
+This plugin compiles **latex** files **asynchronously** while edditing.
+The PDF output gives a **live preview** of your document as you type.
+You have the option to **highlight changes** from the previous save using latexdiff.
+*This plugin is experimental and not well tested*
+
+### live preview of a latex document
+![Demo1 gif](img/demo_1.gif?raw=true)
+### live preview with latexdiff
+![Demo2 gif](img/demo_2.gif?raw=true)
+
+## Installation
+Install using the plugin manager you like.
+For example [vim-plug](https://github.com/junegunn/vim-plug):
+    ```
+        Plug 'donRaphaco/NeoTex', { 'for': 'tex' }
+    ```
+Do `:UpdateRemotePlugins` after installing or updating!
+
+## Usage
+For live previewing your latex file open the created PDF using a PDF viewer which supports auto reloading (I recommend zathura or evince).
+The PDF is created in the same folder where your latex file is stored.
+
+## Options
+
+| Option                            | Default   | Description                               |
+| --------------------------------- | --------- | ----------------------------------------- |
+| `g:neotex_enabled`                | 1         | 0 = always disabled, 1 = default off, 2 = default on |
+| `g:neotex_delay`                  | 1000      | Update intervall                          |
+| `g:neotex_latexdiff`              | 0         | enable latexdiff                          |
+| `g:neotex_latexdiff_options`      | -         | additional options for latexdiff          |
+| `g:neotex_pdflatex_add_options`   | -         | additional options for pdflatex (`-jobname=<filname>` and `-interaction=nonstopmode` is always set) |
+
+## Commands
+| Command       | Description           |
+| ------------- | --------------------- |
+| `:NeoTex`     | Compile current buffer (asynchronously and without writing the file) |
+| `:NeoTexOn`   | Turn live compilation on (for current buffer) |
+| `:NeoTexOff`  | Turn live compilation off (for current bufffer) |