Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/base16-builder/base16-builder
:hammer: Base16 Builder is a nimble command-line tool that generates themes for your favourite programs.
https://github.com/base16-builder/base16-builder
Last synced: 3 days ago
JSON representation
:hammer: Base16 Builder is a nimble command-line tool that generates themes for your favourite programs.
- Host: GitHub
- URL: https://github.com/base16-builder/base16-builder
- Owner: base16-builder
- License: mit
- Created: 2016-01-21T11:26:22.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2021-06-10T22:14:45.000Z (over 3 years ago)
- Last Synced: 2024-10-19T10:30:25.995Z (25 days ago)
- Language: HTML
- Homepage:
- Size: 647 KB
- Stars: 431
- Watchers: 11
- Forks: 41
- Open Issues: 50
-
Metadata Files:
- Readme: readme.md
- Contributing: contributing.md
Awesome Lists containing this project
README
[](https://gitter.im/base16-builder/base16-builder)
[](http://makeapullrequest.com)
[](https://github.com/base16-builder/base16-builder/blob/master/licence.md)
_**Base16 Builder** is a nimble command-line tool that generates themes for your favourite programs. See it in action below:_
Base16 Builder is easy to use. All you have to do is supply a [**color `s`cheme**](https://github.com/alexbooker/base16-builder/tree/master/db/schemes), [**`t`emplate**](https://github.com/alexbooker/base16-builder/tree/master/db/templates), and **`b`rightness** (`light` or `dark`). Base16 Builder will use the information you provide to generate a theme and write it to [*stdout*](https://www.digitalocean.com/community/tutorials/an-introduction-to-linux-i-o-redirection).
Because Base16 Builder writes to stdout, it's possible to pipe the theme anywhere you like. In the above screencast, the theme is piped to a new file called "theme", but this could just as well have been a configuration file like ".Xresources".
You don't have to be savvy with [Unix pipelines](https://en.wikipedia.org/wiki/Pipeline_(Unix)) to enjoy Base16 Builder. If you'd prefer, you can just copy the output with your mouse :relaxed:.
## Features
This project aims to rejuvenate [Chris Kempson's original tool](https://github.com/chriskempson/base16-builder) by incorporating some fresh features:
- [Under active development](https://github.com/alexbooker/base16-builder/pulse/monthly)
- [Well-tested](https://github.com/alexbooker/base16-builder/tree/master/tests)
- Simple to use
- Simpler to [install](https://github.com/alexbooker/base16-builder#installation)
- Writes themes to [`stdout`](https://www.digitalocean.com/community/tutorials/an-introduction-to-linux-i-o-redirection)
- Written in uncomplicated JavaScript
- Works on Mac, Linux, and Windows
## Installation
```
$ npm install --global base16-builder
```
Make sure to install Node.js **before** running the above command. We recommended that you install Node.js using [nvm](https://github.com/creationix/nvm) (the **n**ode **v**ersion **m**anager) or the [pre-built installer for your platform](https://nodejs.org/en/download/). `npm` (the **n**ode **p**ackage **m**anager) is bundled and installed automatically with Node.js.
## Usage
```bash
$ base16-builder --help
Usage:
$ base16-builder <-s scheme> <-t template> <-b light|dark>
$ base16-builder <-s scheme path> <-t template path>
Options:
-s, --scheme Build theme using this color scheme
-t, --template Build theme using this template
-b, --brightness Build theme using this brightness
-h, --help Show this menu
Commands:
ls schemes Opens an offline web page with a list of scheme names and their colors
ls templates Writes a list of available templates to the terminal
Examples:
$ base16-builder -s oceanicnext -t rxvt-unicode -b dark
$ base16-builder --scheme oceanicnext --template rxvt-unicode --brightness dark
$ base16-builder --scheme schemes/customScheme.yml --template templs/customTempl.ejs
$ base16-builder ls schemes
$ base16-builder ls templates
```
## Build Status
| Windows | Linux |
|:------:|:------:|
|[](https://ci.appveyor.com/project/alexbooker/base16-builder) | [](https://travis-ci.org/alexbooker/base16-builder) |
## Attribution
- The [original base16-builder](https://github.com/chriskempson/base16-builder).
- Scheme and template [contributors](https://github.com/chriskempson/base16-builder/graphs/contributors) to the original base16-builder.
- [Phis](https://github.com/Phisherman) for the charming logo.