aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2019-07-24 12:24:14 +1200
committerTom Ryder <tom@sanctum.geek.nz>2019-07-24 12:24:14 +1200
commitfbe775d68f0c182945aa9c9026dbbedf2bf9dc0a (patch)
tree34258ec909e81c5d3f931aba3f690de647ccefe0
parentAdd spacing and commentary to code (diff)
downloadvim-scratch-buffer-fbe775d68f0c182945aa9c9026dbbedf2bf9dc0a.tar.gz
vim-scratch-buffer-fbe775d68f0c182945aa9c9026dbbedf2bf9dc0a.zip
Add documentation
-rw-r--r--README.md12
-rw-r--r--doc/scratch_buffer.txt27
2 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0df98e0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+scratch\_buffer.vim
+===================
+
+User command to open a scratch buffer.
+
+License
+-------
+
+Copyright (c) [Tom Ryder][1]. Distributed under the same terms as Vim itself.
+See `:help license`.
+
+[1]: https://sanctum.geek.nz/
diff --git a/doc/scratch_buffer.txt b/doc/scratch_buffer.txt
new file mode 100644
index 0000000..cc625ca
--- /dev/null
+++ b/doc/scratch_buffer.txt
@@ -0,0 +1,27 @@
+*scratch_buffer.txt* For Vim version 7.0 Last change: 2019 Jul 24
+
+DESCRIPTION *scratch_buffer*
+
+User command to open a scratch buffer.
+
+REQUIREMENTS *scratch_buffer-requirements*
+
+This plugin only loads if 'compatible' is not set.
+
+COMMANDS *scratch_buffer-commands*
+
+ *:ScratchBuffer:*
+
+Execute `:ScratchBuffer` to open the buffer. Wraps around |:new|. Modifier
+prefixes like |:vertical| should work, as should count prefixes to specify the
+window height. Any arguments are passed to |:new|.
+
+AUTHOR *scratch_buffer-author*
+
+Written and maintained by Tom Ryder <tom@sanctum.geek.nz>.
+
+LICENSE *scratch_buffer-license*
+
+Licensed for distribution under the same terms as Vim itself (see |license|).
+
+ vim:tw=78:ts=8:ft=help:norl: