extern/pywal
1
0
Fork 0
mirror of https://github.com/dylanaraps/pywal.git synced 2025-01-24 06:48:41 +01:00
Code Issues Packages Projects Releases Wiki Activity

DOCS: Covnert README to rst.

Browse Source
This commit is contained in:
Dylan Araps 2017-06-24 09:10:42 +10:00
parent 755da29245
commit 809898770b
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.rst
View File

@ -7,6 +7,7 @@ pywal (A ``wal`` rewrite in Python 3)
.. image:: https://travis-ci.org/dylanaraps/wal.py.svg?branch=master .. image:: https://travis-ci.org/dylanaraps/wal.py.svg?branch=master
:target: https://travis-ci.org/dylanaraps/wal.py :target: https://travis-ci.org/dylanaraps/wal.py
``wal`` is a script that takes an image (or a directory of images), ``wal`` is a script that takes an image (or a directory of images),
generates a colorscheme (using ``imagemagick``) and then changes all of generates a colorscheme (using ``imagemagick``) and then changes all of
your open terminal's colorschemes to the new colors on the fly. ``wal`` your open terminal's colorschemes to the new colors on the fly. ``wal``
@ -45,6 +46,7 @@ Dependencies
- Universal wallpaper setting. - Universal wallpaper setting.
Terminal Emulator Terminal Emulator
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
@ -62,6 +64,7 @@ red?
If your terminal's background color is now red, your terminal will work If your terminal's background color is now red, your terminal will work
with ``wal``. with ``wal``.
Installation Installation
------------ ------------
@ -72,17 +75,20 @@ Pip install
pip install pywal pip install pywal
Manual install Manual install
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
Just grab the script (``wal``) and add it to your path. Just grab the script (``wal``) and add it to your path.
Setup Setup
----- -----
**NOTE:** If you get junk in your terminal, add ``-t`` to all of the **NOTE:** If you get junk in your terminal, add ``-t`` to all of the
``wal`` commands. ``wal`` commands.
Applying the theme to new terminals. Applying the theme to new terminals.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -107,6 +113,7 @@ Here's how the extra syntax above works:
& # Run the process in the background. & # Run the process in the background.
( ) # Hide shell job control messages. ( ) # Hide shell job control messages.
Making the colorscheme persist on reboot. Making the colorscheme persist on reboot.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -122,6 +129,7 @@ Without this you'll be themeless until you run ``wal`` again on boot.
# Add this to your .xinitrc or whatever file starts programs on startup. # Add this to your .xinitrc or whatever file starts programs on startup.
wal -i "$(< "${HOME}/.cache/wal/wal")" wal -i "$(< "${HOME}/.cache/wal/wal")"
Usage Usage
----- -----
@ -150,14 +158,10 @@ your terminal colors.
xfce4-terminal) xfce4-terminal)
-v Print "wal" version. -v Print "wal" version.
Customization Customization
------------- -------------
See the ``wal`` wiki! See the ``wal`` wiki!
**https://github.com/dylanaraps/wal.py/wiki** **https://github.com/dylanaraps/pywal/wiki**
.. |MIT licensed| image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: ./LICENSE.md
.. |Build Status| image:: https://travis-ci.org/dylanaraps/wal.py.svg?branch=master
:target: https://travis-ci.org/dylanaraps/wal.py