aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Harder <radhermit@gentoo.org>2014-11-29 00:07:50 -0500
committerTim Harder <radhermit@gentoo.org>2014-11-28 21:13:03 -0800
commit6977bf3aea4673fc9a83081dd19b2d052f83a826 (patch)
treed530179fc843715c7e653619de54d09f123f072b /README.rst
parentsplit copyright and license info out into a separate file (diff)
downloadgentoo-syntax-6977bf3aea4673fc9a83081dd19b2d052f83a826.tar.gz
gentoo-syntax-6977bf3aea4673fc9a83081dd19b2d052f83a826.tar.bz2
gentoo-syntax-6977bf3aea4673fc9a83081dd19b2d052f83a826.zip
update readme info and rename file so github renders it properly
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..22ea221
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,19 @@
+=============
+gentoo-syntax
+=============
+
+A vim plugin that handles Gentoo and portage related syntax highlighting,
+filetype, and indent settings.
+
+Installing
+==========
+
+* Gentoo users: `emerge app-vim/gentoo-syntax`
+* Everyone else: `make PREFIX=~/.vim/ install`
+
+Bugs
+====
+
+Please file issues or submit pull requests on github_.
+
+.. _github: https://github.com/gentoo/gentoo-syntax