Skip to content

Latest commit

 

History

History
125 lines (90 loc) · 3.24 KB

README.md

File metadata and controls

125 lines (90 loc) · 3.24 KB
Raw

cbase16

a blazing fast base16 colorscheme builder

Usage

cbase16 [command] [options]

Command:

  • update: fetch all necessary sources for building
  • build: generate colorscheme templates
  • make: build current directory
  • list: display available schemes and templates
  • version: display version
  • help: display usage message

Update options

  • -c: specify cache directory
  • -l: use original base16 sources

Build options

  • -c: specify cache directory
  • -s: only build specified schemes
  • -t: only build specified templates
  • -o: specify output directory

Make options

  • -c: specify cache directory
  • -C: specify directory to build
  • -s: only build specified schemes
  • -t: only build specified templates
  • -o: specify output directory

List options

  • -c: specify cache directory
  • -s: only show schemes
  • -t: only show templates
  • -r: list items in single column

File Structure

the cache directory is set to $XDG_CACHE_HOME if the variable is not empty, else the cache directory is set to $HOME/.cache

After running update, the file structure for the cache directory will be structured as follows:

  • /sources.yaml
  • /schemes/[name]/*.yaml -- Scheme files
  • /templates/[name]/templates/*.mustache -- Template files
  • /templates/[name]/templates/config.yaml -- Template configuration file

If the update option is coupled with -l, the cache directory will be structured as follows:

  • /sources.yaml -- Holds a list of source repositories for schemes and templates
  • /sources/schemes/list.yaml -- Holds a list of scheme repositories
  • /sources/templates/list.yaml -- Holds a list of template repositories
  • /schemes/[name]/*.yaml -- Scheme files
  • /templates/[name]/templates/*.mustache -- Template files
  • /templates/[name]/templates/config.yaml -- Template configuration file

After running build, the generated colorscheme templates will be in the base16-themes directory by default unless specified otherwise under the current running directory.

Dependencies

  • libgit2 >= 1.1.0
  • yaml-cpp >= 0.6.3

Installation

To compile, run:

$ make

To install, run:

$ make install

To uninstall, run:

$ make uninstall

Manual Installation

After compiling the program by running make, place the executable cbase16 in your $PATH. For example, you could also include this directory in $PATH by adding the following in your profile:

PATH=$PATH:path/to/cbase16

To get zsh completion working, place the _cbase16 completion script in your fpath. For example, you could add the following to your ~/.zshrc to include the directory that contains the _cbase16 file in your $fpath:

fpath=(path/to/cbase16/completion/zsh $fpath)

To get bash completion working, source the cbase16.bash completion script. For example, add the following to your ~/.bashrc:

. path/to/cbase16/completion/bash/cbase16.bash

Reload your shell and the completion script should be working

To get access to the manpage, either place cbase16.1 in your $MANPATH or include this directory in the $MANPATH by adding the following in your profile:

MANPATH=$MANPATH:path/to/cbase16