Skip to content

Commit

Permalink
Use tinted-builder-rust for weekly builds
Browse files Browse the repository at this point in the history
  • Loading branch information
JamyGolden committed Jul 22, 2024
1 parent 1e1d400 commit 4d53f84
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 46 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/update.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
with:
token: ${{ secrets.BOT_ACCESS_TOKEN }}
- name: Update schemes
uses: tinted-theming/base16-builder-go@latest
uses: tinted-theming/tinted-builder-rust@latest
- name: Commit the changes, if any
uses: stefanzweifel/git-auto-commit-action@v5
with:
Expand Down
60 changes: 15 additions & 45 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,67 +1,37 @@
# Contributing

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

## Building

### Dependencies

- `>=0.2.0` [base16-builder-go][1]
- golang `>=1.16` to build base16-builder-go
- `>=0.9.3` [tinted-builder-rust]

### Usage for template editing

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 `tinted-shell` repository: `./base16-builder-go
-template-dir ../tinted-shell`

Or the above steps represented in shell commands:

```shell
cd /path/to/tinted-shell/../ # This repos parent dir
git clone git@github.com:tinted-theming/base16-builder-go.git
cd base16-builder-go
go build ./base16-builder-go/base16-builder-go \
-template-dir ../tinted-shell
```
1. Install [tinted-builder-rust]
1. `tinted-builder-rust build path/to/tinted-shell`

### 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.
1. Clone the tinted-shell
1. Clone [tinted-schemes]
1. Install [tinted-builder-rust]
1. Execute `tinted-builder-rust build tinted-shell` with
- `--schemes-dir` arg - provide `/path/to/tinted-scehemes`

```shell
base16-builder-go \
-schemes-dir /path/to/base16-schemes \
-template-dir /path/to/tinted-shell
tinted-builder-rust build /path/to/tinted-shell \
--schemes-dir /path/to/tinted-schemes
```

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

## Submitting a PR

- 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][5]
- [Issue template for feature requests][6]
[tinted-builder-rust]: https://github.com/tinted-theming/tinted-builder-rust
[tinted-schemes]: https://github.com/tinted-theming/schemes
[GitHub Action]: .github/workflows/update.yml

[1]: https://github.com/tinted-theming/base16-builder-go
[2]: https://github.com/tinted-theming/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

0 comments on commit 4d53f84

Please sign in to comment.