From aa05f22652b8b7f0ffef776ea39ec88381a4e75f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kim=20Silkeb=C3=A6kken?= Date: Mon, 5 Aug 2013 10:56:27 +0200 Subject: [PATCH] Update README --- README.rst | 47 ++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 42 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index a5a4fee6..595bd29f 100644 --- a/README.rst +++ b/README.rst @@ -9,16 +9,53 @@ Powerline :target: `travis-build-status`_ :alt: Build status -This is the upcoming version of Powerline, implemented in Python. The -project is currently in a stable beta and almost ready for release. +.. _travis-build-status: https://travis-ci.org/Lokaltog/powerline + +**Powerline is a statusline plugin for vim, and provides statuslines and +prompts for several other applications, including zsh, bash, tmux, IPython, +Awesome and Qtile.** + +Features +-------- + +* **Extensible and feature rich, written in Python.** Powerline was + completely rewritten in Python to get rid of as much vimscript as + possible. This has allowed much better extensibility, leaner and better + config files, and a structured, object-oriented codebase with no mandatory + third-party dependencies other than a Python interpreter. +* **Stable and testable code base.** Using Python has allowed unit testing + of all the project code. The code is tested to work in Python 2.6+ and + Python 3. +* **Support for prompts and statuslines in many applications.** Originally + created exclusively for vim statuslines, the project has evolved to + provide statuslines in tmux and several WMs, and prompts for shells like + bash/zsh and other applications. It's simple to write renderers for any + other applications that Powerline doesn't yet support. +* **Configuration and colorschemes written in JSON.** JSON is + a standardized, simple and easy to use file format that allows for easy + user configuration across all of Powerline's supported applications. +* **Fast and lightweight, with daemon support for even better performance.** + Although the code base spans a couple of thousand lines of code with no + goal of "less than X lines of code", the main focus is on good performance + and as little code as possible while still providing a rich set of + features. The new daemon also ensures that only one Python instance is + launched for prompts and statuslines, which provides excellent + performance. + +*But I hate Python / I don't need shell prompts / this is just too much +hassle for me / what happened to the original vim-powerline project / …* + +You should check out some of the Powerline derivatives. The most lightweight +and feature-rich alternative is currently Bailey Ling's `vim-airline +`_ project. + +------ * Consult the `documentation `_ for more information and installation instructions. * Check out `powerline-fonts `_ - for pre-patched versions of popular coding fonts. - -.. _travis-build-status: https://travis-ci.org/Lokaltog/powerline + for pre-patched versions of popular, open source coding fonts. Screenshots -----------