aboutsummarylogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000000..cfee6d7bcbb6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# neovim-gnome-terminal-wrapper
+
+![screenshot](screenshot.gif)
+
+Wraps the neovim binary in a separate gnome-terminal session, making it
+possible to use it as a regular application (it is tracked correctly by the DE,
+it can be associated to filetypes, etc.)
+
+## Requisites
+
+* neovim
+* gnome-terminal
+* python-dbus
+
+## Setup
+
+On Arch, install `neovim-gnome-terminal-wrapper` from the AUR.
+
+Manually:
+
+~~~
+cp nvim-wrapper /usr/bin/nvim-wrapper
+cp neovim.desktop /usr/share/applications/neovim.desktop
+cp neovim.svg /usr/share/icons/neovim.svg
+~~~