Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
joshwlewis committed Nov 5, 2017
1 parent ec1f394 commit ae587bc
Showing 1 changed file with 31 additions and 14 deletions.
45 changes: 31 additions & 14 deletions README.md
@@ -1,29 +1,46 @@
## Base16 Unikitty

A vibrant color scheme for hacking. Includes themes for nearly every editor, terminal, and IDE. Find yours [here](https://github.com/joshwlewis/base16-unikitty/tree/master/output).
A vibrant color scheme for hacking. Includes themes for nearly every editor, terminal, and IDE. Find yours in the [output directory](https://github.com/joshwlewis/base16-unikitty/tree/master/output).

![light](https://d.pr/S9Dxd+.png)

![light](https://www.dropbox.com/s/c1ozb122q2m0cbb/Screenshot%202016-08-20%2023.02.21.png?dl=1)
![dark](http://d.pr/i/s7kAP2+.png)

These templates were designed for, and the outputs generated by Base16 Builders.

![dark](https://www.dropbox.com/s/1441un9w3ydwasi/Screenshot%202016-08-20%2023.01.56.png?dl=1)
There are three variants of the scheme:

- A dark scheme targeted specifically at generating dark background themes.
- A light scheme targeted specifically at generating light background themes.
- A reversible scheme which uses the same colors for generating both dark and
light themes.

These templates were designed, and the outputs generated by Base16 Builders.
The dark and light schemes are crafted to maximize legibility while maintaining
the warm and vibrant feel. The reversible theme trades a bit of legibility for
a universal color palatte, one that uses the same colors for both dark and light
schemes.

The reversible scheme is intended to be consumed by the older Base16 Builders
that generate dark and light variants with the same scheme. The reversible
scheme is intended for use with the legacy type builders like:
The dark and light schemes target the most modern Base16 Builders, and aim to
solve some of the legibility problems of the legacy Base16 Builder outputs. For
those reasons, I reccomend these over any of the reversible schemes.

- [Base16 Builder](https://github.com/chriskempson/base16-builder) by [Chris
Kempson](https://github.com/chriskempson)
- [Base16 Builder](https://github.com/base16-builder/base16-builder) by
[base16-builder](https://github.com/base16-builder)
However, the reversible variant has a uniform palatte in both light and dark,
which is nice if you want use or switch between variants. Additionally, because
it targets legacy Base16 Builders, there are generally more templates available.
If you can't find your IDE/Editor/Terminal/Shell in the light and dark output,
it might be available in the reversible output.

The light and dark themes are for consumption by newer builders that expect
to generate only one variant. You could use the light and dark variants against
builders like
If you want to generate your own output, the light and dark schemes are
intended to work with modern (v 0.9.0+) Base16 Builders, such as:

- [Base16 Builder PHP](https://github.com/chriskempson/base16-builder-php) by
[Chris Kempson](https://github.com/chriskempson)
- [Base16 Builder Elixir](https://github.com/obahareth/base16-builder-elixir) by
[Omar Bahareth](https://github.com/obahareth)

And the reversible scheme works well with legacy Base16 Builders, like:

- [Base16 Builder](https://github.com/chriskempson/base16-builder) by [Chris
Kempson](https://github.com/chriskempson)
- [Base16 Builder](https://github.com/base16-builder/base16-builder) by
[base16-builder](https://github.com/base16-builder)

0 comments on commit ae587bc

Please sign in to comment.