aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWynn Wolf Arbor2020-04-28 17:32:07 +0200
committerWynn Wolf Arbor2020-04-28 18:12:05 +0200
commit500ea5955c44c4526b62f0f0f944841d37b18eac (patch)
tree350d4f655ceea9422f27316c05a021f8f7c06878
parent9f853addd1fdb44966eaaf904114542061a38c5b (diff)
downloadvim-beancount-500ea5955c44c4526b62f0f0f944841d37b18eac.tar.gz
Update README with details about this fork
Diffstat (limited to '')
-rw-r--r--README.md21
1 files changed, 10 insertions, 11 deletions
diff --git a/README.md b/README.md
index b2d00a8..4d6acd8 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,20 @@
# vim-beancount
-This is the beancount filetype for Vim. Includes highlighting and some basic
-functions.
+This is a mildly simplified fork of vim-beancount, with the following changes:
-## Installation
+- Dropped support for syntastic, ale, and deoplete. I don't use these plugins.
+- AlignCommodity is fully replaced with `bean-format` through `formatprg`.
-I suggest [Vundle](https://github.com/gmarik/Vundle.vim) or
-[Pathogen](https://github.com/tpope/vim-pathogen), but you can also just
-copy all of the files into the appropriate places inside your '.vim' directory.
+More code might be refactored or rewritten in the future. The overall goal is
+to simplify and minimize, preferring the use of native vim and beancount
+functionality instead of depending on additional code or other plugins.
-## Feature Highlights
+Keep in mind that this is first and foremost for personal use.
-* Syntax highlighting and indenting.
+## Installation
-* Completion: Type `Ex:Oth` followed by `^X^O` to get `Expenses:Donations:Other`
- (provided that you have opened an account with that name).
+Use native Vim package support, see https://vimhelp.org/repeat.txt.html#packages
-* Use `:make` to run `bean-check` and load errors in the quickfix window.
+## Feature Highlights
For full details, see [doc/beancount.txt](doc/beancount.txt).