Skip to content

Commit

Permalink
Update readme to reflect tinted-builder-rust change
Browse files Browse the repository at this point in the history
  • Loading branch information
JamyGolden committed Jul 22, 2024
1 parent 5283125 commit e072063
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 40 deletions.
54 changes: 16 additions & 38 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,36 @@
# Contributing

This repository includes a [GitHub Action][4] that builds the
colorschemes once a week. This keeps the themes up-to-date
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 `base16-fzf` repository: `./base16-builder-go
-template-dir ../base16-fzf`

Or the above steps represented in shell commands:

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

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

```shell
base16-builder-go \
-schemes-dir /path/to/base16-schemes \
-template-dir /path/to/base16-fzf
tinted-builder-rust build /path/to/tinted-fzf \
--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].

[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
[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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ shell environments, enhancing your experience with fzf.
See [CONTRIBUTING.md], which contains building and contributing
instructions.

This theme was built with [builder-go].
This template's themes were built with [builder-rust].

## Screenshots

Expand All @@ -81,7 +81,7 @@ This theme was built with [builder-go].
[Base24]: https://github.com/tinted-theming/base24
[Tinted Theming]: https://github.com/tinted-theming/home
[fzf]: https://github.com/junegunn/fzf
[builder-go]: https://github.com/tinted-theming/base16-builder-go
[builder-rust]: https://github.com/tinted-theming/tinted-builder-rust
[CONTRIBUTING.md]: CONTRIBUTING.md
[base16-fzf]: https://github.com/tinted-theming/base16-fzf
[1]: screenshots/base16-solarized-dark.png
Expand Down

0 comments on commit e072063

Please sign in to comment.