From c5113592c27d415d6ea42ddcf28e6c46259d2311 Mon Sep 17 00:00:00 2001 From: Alex Vear Date: Sun, 22 Sep 2019 21:53:27 +0100 Subject: [PATCH] Update README and Vim doc introduction --- README.md | 24 +++++++++++++++--------- doc/org.txt | 9 +++++---- 2 files changed, 20 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 2a641d1..4ed4ca6 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,16 @@ # Org mode and Outline mode syntax highlighting for Vim -Org.vim is a minimal [Org mode](https://orgmode.org/) plugin for -[Vim](https://www.vim.org/). It provides only the absolute necessities (e.g. -syntax highlighting and folding) at a high standard. +Org.vim is a very minimal [Org mode][] and [Outline mode][] plugin for +[Vim](https://www.vim.org) providing only syntax highlighting and folding. -The main goal of this plugin is to replicate [Vim's default -Markdown](https://github.com/tpope/vim-markdown/) editing experience for -Org mode files. +This plugin aims to replicate Vim's [existing Markdown](https://github.com/tpope/vim-markdown/) +editing experience on Org mode (and Outline mode) files, rather than trying to +be a full featured Org mode plugin -- that is what Emacs is for. + +Originally created so I would be able to quickly edit and easily read Org mode +files in Vim without all _the bells and whistles_ the Emacs version provides. +It also allowed me use [Orgzly](https://github.com/orgzly/orgzly-android/) +(highly recommended) without worrying about Emacs lock-in. ## Licence @@ -15,7 +19,9 @@ Copyright (c) 2018-2019, Alex Vear. Org.vim is distributed under the same terms as Vim itself. A copy of the full licence text should have been provided with this extension -in the `LICENCE` file. The license can also be viewed on the [web][] or by -invoking `:help license` from within Vim. +in the `LICENCE` file. The license can also be viewed on the +[web](http://vimdoc.sourceforge.net/htmldoc/uganda.html#license) or by invoking +`:help license` from within Vim. -[web]: +[Outline mode]: https://www.gnu.org/software/emacs/manual/html_node/emacs/Outline-Mode.html +[Org mode]: https://orgmode.org diff --git a/doc/org.txt b/doc/org.txt index 0a74485..0f4cdf8 100644 --- a/doc/org.txt +++ b/doc/org.txt @@ -16,11 +16,12 @@ Welcome to the org.vim user manual. *org* *org.vim* *vim-org* *out ============================================================================== 1. INTRODUCTION *org-intro* -Org.vim is a minimal Org mode package for Vim. It provides only the absolute -necessities (e.g. syntax highlighting and folding) at a high standard. +Org.vim is a very minimal Org mode [2] and Outline mode [1] plugin for Vim +providing only syntax highlighting and folding. -The main goal of this package is to replicate Vim's default Markdown editing -experience for Org mode files. +This plugin aims to replicate Vim's existing Markdown editing experience on +Org mode (and Outline mode) files, rather than trying to be a full featured +Org mode plugin -- that is what Emacs is for. ============================================================================== 2. INSTALLATION *org-install*