Installation
************

.. contents::
   :local:

.. spelling:word-list::
   gzip

Download
========

You can download the latest release from GitHub, using ``git`` or downloading
the theme file directly.

Install with Git
----------------

To download to ``~/liquidprompt-powerline``, run::

   git clone --branch main https://github.com/liquidprompt/liquidprompt-powerline.git ~/liquidprompt-powerline

Or, if you want to use the development (non-stable) branch::

   git clone https://github.com/liquidprompt/liquidprompt-powerline.git ~/liquidprompt-powerline

Install by direct download
--------------------------

If you do not have ``git``, you can download and extract the source in zip or
gzip format directly from the `release page
<https://github.com/liquidprompt/liquidprompt-powerline/releases/latest>`_.

Alternatively, you can download the theme file directly::

   https://raw.githubusercontent.com/liquidprompt/liquidprompt-powerline/main/powerline.theme

Or, if you want to use the development (non-stable) branch::

   https://raw.githubusercontent.com/liquidprompt/liquidprompt-powerline/main/powerline.theme

Setup
=====

By default, the dividers and markers used are the Powerline private characters.
You will either need a compatible font, or to configure the dividers and markers
to use other characters.

See the `Powerline Fonts installation docs`_ for help.

.. _`Powerline fonts installation docs`: https://powerline.readthedocs.io/en/latest/installation.html#fonts-installation

Usage
=====

See the Liquid Prompt documentation on `switching themes`_ for details on how to
load and use these themes.

.. _`switching themes`: https://liquidprompt.readthedocs.io/en/stable/theme.html#switching-themes