commit b93c6737116fc38b1cffc0713b71ae0c47db6889
parent 866ba47ae993861568192d34507cd298dd3f7583
Author: Alex Balgavy <alex@balgavy.eu>
Date: Mon, 28 Jun 2021 11:31:45 +0200
Update README
Diffstat:
1 file changed, 16 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -1,8 +1,22 @@
# vim-literate-markdown
+## What?
+
This is a Vim plugin that attempts to replicate a subset of the features of Emacs' Org mode code handling.
So for example, tangling the code from the current file, or executing blocks of code.
-Except it's for Markdown files, not for Org.
-Markdown is a much more universal syntax in my opinion.
+For this purpose, it provides some mappings and commands for Markdown files.
This plugin is a work in progress and far from complete.
For more information about its features, see doc/literate-markdown.txt.
+
+**Disclaimer:** this code is not extensively tested. It works for me, running Vim 8.2 in the terminal on macOS, but it's not guaranteed to work for others. It might not work in Neovim, as I don't use Neovim.
+
+## Why?
+
+Literate programming is a great way to provide explanation about what you're doing in code.
+Emacs does this very well; I didn't know about anything similar for Vim, particularly for Markdown files.
+So I wrote this to allow literate programming in Markdown, because in my opinion Markdown is a much more universal syntax than Org.
+
+## Installation
+
+You can use your favorite plugin manager (I recommend [vim-plug](https://github.com/junegunn/vim-plug)).
+You can also use Vim's built-in package functionality (`:h packages`).
