diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 70 |
1 files changed, 49 insertions, 21 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 382d0e1..9f459b1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,39 +1,67 @@ # Contributing +This repository includes a [GitHub Action][4] that builds the +colorschemes once a week. This keeps the colorschemes up-to-date +automatically. + ## Building -Dependencies: +### Dependencies + +- `>=0.2.0` [base16-builder-go][1] +- golang `>=1.16` to build base16-builder-go -- Python, at least version 3.5 -- The `pybase16` command from - [base16-builder-python](https://github.com/InspectorMustache/base16-builder-python) -- The `make` command +### Usage for template editing -For example on a Debian-based distribution: +1. Clone [base16-builder-go][1] somewhere on your system. +1. Run `cd /path/to/base-builder-go && go build` to generate a binary: +`/path/to/base-builder-go/base16-builder-go` +1. Now execute the binary you generated while giving the `-template-dir` +arg the path to `base16-vim` repository: `./base16-builder-go +-template-dir ../base16-vim` +Or the above steps represented in shell commands: + +```shell +cd /path/to/base16-vim/../ # This repos parent dir +git clone git@github.com:base16-project/base16-builder-go.git +cd base16-builder-go +go build ./base16-builder-go/base16-builder-go \ + -template-dir ../base16-vim ``` -# Install dependencies (you probably already have pip/pip3 and make) -apt install build-essential # for make -pip3 install pybase16-builder -# Build the packages -make +### Usage for adding or editing a colorscheme + +If you want to add or edit a colorscheme but want to test it out, you +simply need to pass in your local [base16-schemes][2] directory when +executing the `base16-builder-go` binary. + +```shell +base16-builder-go \ + -schemes-dir /path/to/base16-schemes \ + -template-dir /path/to/base16-vim ``` -## Submitting a PR +If you have more questions about [base16-builder-go][1], have a look at +the information on the GitHub page. -After you've installed the build dependencies, and before you submit your PR: +## Submitting a PR -- Run `make` after you've made your changes. This will build all the themes - based on the changes you've made. For instance, instead of manually editing - files under `colors/`, you should edit `templates/default.mustache` -- Make sure to commit the changes from `make` and include them in your PR. -- Please abide by what's requested in the [PR - template](/.github/pull_request_template.md). +- Run the colorscheme generation using [base16-builder-go][1] 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][4]. ## Submitting an issue Please follow the instructions in the issue templates: -- [Issue template for bug reports](/.github/ISSUE_TEMPLATE/bug_report.md) -- [Issue template for feature requests](/.github/ISSUE_TEMPLATE/feature_request.md) +- [Issue template for bug reports][5] +- [Issue template for feature requests][6] + +[1]: https://github.com/base16-project/base16-builder-go +[2]: https://github.com/base16-project/base16-schemes +[3]: .github/workflows/update.yml +[4]: .github/pull_request_template.md +[5]: .github/ISSUE_TEMPLATE/bug_report.md +[6]: .github/ISSUE_TEMPLATE/feature_request.md |