1 files changed, 92 insertions, 0 deletions
diff --git a/debian/powerline.README.Debian b/debian/powerline.README.Debian
new file mode 100644
index 0000000..1640ac9
--- /dev/null
+++ b/debian/powerline.README.Debian
@@ -0,0 +1,92 @@
+Powerline for Debian
+--------------------
+
+Once installed, a few simple steps are needed to activate Powerline in your
+favorite editor and/or shell.
+
+bash
+----
+
+Add the following line to your ~/.bashrc file:
+
+  . /usr/share/powerline/bindings/bash/powerline.sh
+
+or use:
+
+  sudo dpkg-reconfigure -plow powerline
+
+to globally enable/disable powerline automatically for all users on the system.
+
+tmux
+----
+
+Add the following lines in your ~/.tmux.conf file:
+
+  source '/usr/share/powerline/bindings/tmux/powerline.conf'
+
+vim
+---
+
+Make sure the vim-nox package is installed, and insert the following lines in
+your ~/.vimrc file:
+
+  python3 from powerline.vim import setup as powerline_setup
+  python3 powerline_setup()
+  python3 del powerline_setup
+
+Replace 'python3' with 'python' on Debian 9 (stretch) and earlier.
+
+Alternatively, if the vim-addon-manager package is installed, the following
+command may be used:
+
+  vim-addons install powerline
+
+zsh
+---
+
+Add the following line in your ~/.zshrc file:
+
+  . /usr/share/powerline/bindings/zsh/powerline.zsh
+
+others
+------
+
+Powerline also supports other prompts and statuslines. See the documentation in
+the powerline-doc for the complete list of supported programs and installation
+instructions.
+
+
+Configuration
+-------------
+
+The default configuration files for Powerline are located in
+/usr/share/powerline/config_files
+
+root may customize Powerline system-wide by copying the contents of this
+directory into /etc/powerline and modifying the JSON-formatted configuration
+files. This will overwrite the configuration from
+/usr/share/powerline/config_files and apply globally for all users on the
+system.
+
+Additionally a user may customize Powerline by using ~/.config/powerline
+accordingly. This will overwrite both the configuration from
+/usr/share/powerline/config_files and /etc/powerline, applying to the current
+user only.
+
+Documentation for the various configuration options is found in the
+powerline-doc package, at this URL:
+
+  file:///usr/share/doc/powerline/html/configuration.html#main-configuration
+
+Daemon
+------
+
+Powerline provides a daemon that can be used to improve its performance when
+it is used in multiple concurrent applications. It can be started using the
+following command:
+
+  $ systemctl --user start powerline-daemon.service
+
+To start the daemon automatically upon login:
+
+  $ systemctl --user enable powerline-daemon.service