aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Byron <=>2015-07-17 17:39:49 +1000
committerDaniel Byron <=>2015-07-17 17:39:49 +1000
commit16feb7f89d81e5730c6a7303a882f749311b8797 (patch)
tree39e6c23b12008d55f9c9070883f3f6f5d1d4c5d1
parentMoved from Bitbucket to Github (diff)
downloadschemer2-16feb7f89d81e5730c6a7303a882f749311b8797.tar.xz
schemer2-16feb7f89d81e5730c6a7303a882f749311b8797.zip
Updated readme
-rw-r--r--README.md56
1 files changed, 26 insertions, 30 deletions
diff --git a/README.md b/README.md
index 8f2134e..e5e7d03 100644
--- a/README.md
+++ b/README.md
@@ -6,17 +6,14 @@ Terminal Colorscheme Generator
==============================
## Screenshot
-![Screenshot](http://i.imgur.com/TSLluID.png)
+![Screenshot](http://i.imgur.com/63R70Iz.png)
+[More Screenshots](http://imgur.com/a/Kz9Av)
## Installation
-### AUR
-
-There is now an AUR package for schemer at https://aur.archlinux.org/packages/schemer/
-
### Short version
-> go get github.com/thefryscorer/schemer
+> go get github.com/thefryscorer/schemer2
### Long Version
@@ -31,45 +28,44 @@ You will also need to set the GOPATH variable so that Go knows where to put thin
NOTE: You don't need to (and shouldn't) set the $GOROOT variable. This is handled for you and you shouldn't mess with it.
-#### Installing SDL1.2
-This program also makes use of SDL1.2 for the color preview window (which you can use by adding the "-d" flag in schemer). As such, SDL1.2 will need to be installed on your system for you to build and run schemer.
-
-**To install SDL1.2 in ArchLinux:**
-
-> sudo pacman -S sdl sdl_image sdl_ttf sdl_mixer
-
-**To install SDL1.2 in Mac OS:**
-
-> brew install sdl sdl_image sdl_ttf sdl_mixer
-
-If you haven't installed HomeBrew, you can find it at http://brew.sh
-
-
-**To install SDL1.2 on another system:**
-
-Learn how to use Google and your package manager. Both are very useful.
-
#### Installing schemer
You should now be able to install schemer using the command:
-> go get github.com/thefryscorer/schemer
+> go get github.com/thefryscorer/schemer2
-And it will be built in your GOPATH directory, in a subdirectory named 'bin'. To run it, you can either add $HOME/Go/bin to your system path and run it as you would any other command. Or cd into the bin directory and run it with:
+And it will be built in your GOPATH directory, in a subdirectory named 'bin'. To run it, you can either add $GOPATH/bin to your system path and run it as you would any other command. Or cd into the bin directory and run it with:
-> ./schemer
+> ./schemer2
## Usage
-> schemer -term="xfce" Image.png
+#### Reading from terminal config and outputting to image
+> schemer2 -in=xterm:$HOME/.Xresources -outputImage=out.png
+
+#### Reading from that image and outputting terminal config (lilyterm)
+> schemer2 -in=img:out.png -out=lilyterm
+
+#### Reading from Xresources and outputting in termite format
+> schemer2 -in=xterm:$HOME/.Xresources -out=termite
+
+#### Getting colors from image, and outputting a new image
+> schemer2 -in=img:old.png -outputImage=new.png
-Then copy the generated config lines into your terminal config file.
## Features
- Outputs configuration in several different formats for different terminals.
- Configurable color difference threshold
- Configurable minimum and maximum brightness value
-- Can preview colorscheme in SDL window
+
+## Supported input formats
+
+- Images (png, jpeg)
+- Xfce4 terminalrc
+- Lilyterm config
+- Terminator config
+- Termite config
+- Xterm/URXvt and variants
## Supported output formats