Merge pull request #55 from dylanaraps/alpha

docs: Move documentation to the wiki.

README.md

@@ -14,135 +14,29 @@ For more info, check out the [Wiki](https://github.com/dylanaraps/pywal/wiki).
 
 [Albums of examples (Warning large)](https://dylanaraps.com/pages/rice)
 
-![screen](https://i.imgur.com/hkAJjJg.png)
+![screenshot](https://i.imgur.com/hkAJjJg.png)
 
 
 ## Table of Contents
 
 <!-- vim-markdown-toc GFM -->
-* [Requirements](#requirements)
-    * [Dependencies](#dependencies)
-    * [Terminal Emulator](#terminal-emulator)
 * [Installation](#installation)
-* [Setup](#setup)
+* [Getting Started](#getting-started)
-    * [Applying the theme to new terminals.](#applying-the-theme-to-new-terminals)
-    * [Making the colorscheme persist on reboot.](#making-the-colorscheme-persist-on-reboot)
-* [Usage](#usage)
 * [Customization](#customization)
 
 <!-- vim-markdown-toc -->
 
 
-## Requirements
-
-
-### Dependencies
-
-- `linux`
-- `python 3.6`
-- `imagemagick`
-    - Colorscheme generation.
-- `xfce`, `gnome`, `cinnamon`, `mate`
-    - Desktop wallpaper setting.
-- `feh`, `nitrogen`, `bgs`, `hsetroot`, `habak`
-    - Universal wallpaper setting.
-
-
-### Terminal Emulator
-
-To use `wal` your terminal emulator must support a special type of escape sequence. The command below can be used as a test to see if `wal` will work with your setup.
-
-Run the command below, does the background color of your terminal become red?
-
-```sh
-printf "%b" "\033]11;#ff0000\007"
-```
-
-If your terminal's background color is now red, your terminal should work with `wal`.
-
-
-**Terminals that DON'T work with `wal`.**
-
-- Konsole. [#24](https://github.com/dylanaraps/pywal/issues/24)
-- Alacritty. [#37](https://github.com/dylanaraps/pywal/issues/37)
-- Iterm.
-- Hyper.
-- Terminal.app.
-- Terminology. [#50](https://github.com/dylanaraps/pywal/issues/50)
-
 ## Installation
 
 https://github.com/dylanaraps/pywal/wiki/Installation
 
 
-## Setup
+## Getting Started
 
-**NOTE:** If you get junk in your terminal, add `-t` to all of the `wal` commands.
+https://github.com/dylanaraps/pywal/wiki/Getting-Started
 
-### Applying the theme to new terminals.
-
-`wal` only applies the new colors to the currently open terminals. Any new terminal windows you open won't be using the new theme unless you add a single line to your shell's start up file. (`.bashrc`, `.zshrc` etc.) The `-r` flags tells `wal` to find the current colorscheme inside the cache and then set it for the new terminal.
-
-Add this line to your shell startup file. (`.bashrc`, `.zshrc` or etc.)
-
-```sh
-# Import colorscheme from 'wal'
-(wal -r &)
-
-# If the command above doesn't work,
-# try this alternative.
-setsid wal -r
-```
-
-Here's how the extra syntax above works:
-
-```sh
-&   # Run the process in the background.
-( ) # Hide shell job control messages.
-```
-
-### Making the colorscheme persist on reboot.
-
-On reboot your new colorscheme won't be set or in use. To fix this you have to add a line to your `.xinitrc` or whatever file starts programs on your system. This `wal` command will set your wallpaper to the wallpaper that was set last boot and also apply the colorscheme again.
-
-Without this you'll be themeless until you run `wal` again on boot.
-
-```sh
-# Add this to your .xinitrc or whatever file starts programs on startup.
-wal -i "$(< "${HOME}/.cache/wal/wal")"
-```
-
-
-## Usage
-
-Run `wal` and point it to either a directory (`wal -i "path/to/dir"`) or an image (`wal -i "/path/to/img.jpg"`) and that's all. `wal` will change your wallpaper for you and also set your terminal colors.
-
-```sh
-usage: wal [-h] [-c] [-i "/path/to/img.jpg"]
-                   [-f "/path/to/colorscheme/file"] [-n] [-o "script_name"]
-                   [-q] [-r] [-t] [-v]
-
-wal - Generate colorschemes on the fly
-
-optional arguments:
-  -h, --help            show this help message and exit
-  -c                    Delete all cached colorschemes.
-  -i "/path/to/img.jpg"
-                        Which image or directory to use.
-  -f "/path/to/colorscheme/file"
-                        Which colorscheme file to use.
-  -n                    Skip setting the wallpaper.
-  -o "script_name"      External script to run after "wal".
-  -q                    Quiet mode, don"t print anything and don't display
-                        notifications.
-  -r                    Reload current colorscheme.
-  -t                    Fix artifacts in VTE Terminals. (Termite,
-                        xfce4-terminal)
-  -v                    Print "wal" version.
-```
 
 ## Customization
 
-See the `wal` wiki!
+https://github.com/dylanaraps/pywal/wiki
-
-**https://github.com/dylanaraps/pywal/wiki**