From d2ecdb4ed3bcad34ad13cb55a1ee323c5f5a7adb Mon Sep 17 00:00:00 2001 From: Alex Vear Date: Fri, 6 Dec 2019 22:21:15 +0000 Subject: [PATCH] Rewrite README in Org mode format --- README.md | 31 ------------------------------- README.org | 28 ++++++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 31 deletions(-) delete mode 100644 README.md create mode 100644 README.org diff --git a/README.md b/README.md deleted file mode 100644 index 3df96e3..0000000 --- a/README.md +++ /dev/null @@ -1,31 +0,0 @@ -# Org mode and Outline mode syntax highlighting for Vim - -Org.vim is a very minimal [Org mode][] and [Outline mode][] plugin for -[Vim](https://www.vim.org) providing only syntax highlighting and folding. - -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 any of _the bells and whistles_ of the original Emacs -implementation. It also allowed me use [Orgzly](https://github.com/orgzly/orgzly-android/) -(highly recommended) without worrying about Emacs lock-in. - -**Notice**: this project is considered complete by the author. You can still -report bugs and request additional features, however it is unlikely that new -features will be added. - -## Licence - -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](http://vimdoc.sourceforge.net/htmldoc/uganda.html#license) or by invoking -`:help license` from within Vim. - -[Outline mode]: https://www.gnu.org/software/emacs/manual/html_node/emacs/Outline-Mode.html -[Org mode]: https://orgmode.org diff --git a/README.org b/README.org new file mode 100644 index 0000000..00ef769 --- /dev/null +++ b/README.org @@ -0,0 +1,28 @@ +#+TITLE: Org mode and Outline mode syntax highlighting for Vim + +Org.vim is a very minimal [[https://orgmode.org][Org mode]] and [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Outline-Mode.html][Outline mode]] plugin for +[[https://www.vim.org][Vim]] providing only syntax highlighting and folding. + +This plugin aims to replicate Vim's [[https://github.com/tpope/vim-markdown/][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. + +Originally created so I would be able to quickly edit and easily read Org mode +files in Vim without any of /the bells and whistles/ of the original Emacs +implementation. It also allowed me use [[https://github.com/orgzly/orgzly-android/][Orgzly]] +(highly recommended) without worrying about Emacs lock-in. + +*Notice*: this project is considered complete by the author. You can still +report bugs and request additional features, however it is unlikely that new +features will be added. + +** Licence + +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 +[[http://vimdoc.sourceforge.net/htmldoc/uganda.html#license][web]] or by invoking +~:help license~ from within Vim.