Skip to content

Latest commit

 

History

History
66 lines (48 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

66 lines (48 loc) · 1.98 KB

Contributing

This repository includes a GitHub Action that builds the colorschemes once a week. This keeps the colorschemes up-to-date automatically.

Building

Dependencies

Usage for template editing

  1. Clone the template repository onto your system
  2. Download the latest base16-builder-go binary
  3. Execute the binary with the -template-dir arg and provide /path/to/base16-vim

Or the above steps represented in shell commands:

/path/to/base16-builder-go-binary \
  -template-dir "/path/to/base16-vim"

Usage for adding or editing a colorscheme

  1. Clone the base16-vim
  2. Clone schemes
  3. Download the latest base16-builder-go binary
  4. Execute the binary with
  • -schemes-dir arg - provide /path/to/schemes/base16
  • -template-dir arg - provide /path/to/base16-vim (base16-vim repository)
/path/to/base16-builder-go-binary \
  -schemes-dir "/path/to/schemes/base16" \
  -template-dir "/path/to/base16-vim"

If you have more questions about base16-builder-go, have a look at the information on the GitHub page.

Submitting a PR

  • Run the colorscheme generation using base16-builder-go and commit the changes in your PR. Don't make changes directly to the generated colorschemes, make changes to the template instead.
  • Please abide by what's requested in the PR template.

Submitting an issue

Please follow the instructions in the issue templates: