Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,23 +1,27 @@
.PHONY: all
all: docs build
all: format build test

.PHONY: docs
docs:
go generate

.PHONY: build
build:
go build -o bloom .

.PHONY: docs
docs:
go run . doc --format md bloom_doc/

.PHONY: test
test:
go test ./...

.PHONY: fmt
fmt:
.PHONY: format
format:
go fmt ./...

.PHONY: check
check:
golangci-lint run ./...

.PHONY: clean
clean:
rm -f bloom
rm -rf docs/*.md
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,21 @@ go build -o $(go env GOPATH)/bin/bloom github.com/rose-pine/rose-pine-bloom

## Usage

Start by creating a template file. This will look similar to your desired theme file, replacing colour values with Rosé Pine variables. For example, `#ebbcba` would now be `$rose`. Already have a theme? You can [create a template](#create-a-template) from an existing theme.
> See our [full documentation](./docs/bloom.md) for more information.

See
- [cli documentation](./bloom_doc/bloom.md)
- [process a template](./bloom_doc/bloom_build.md)
- [create a template from a theme](./bloom_doc/bloom_build-template.md)
For existing themes, use `bloom init` ([docs](./docs/bloom_init.md)) to create a template, for example:

```sh
bloom init theme.json
# This will create a template.json file in the same directory
```

To build your themes, use `bloom build` ([docs](./docs/bloom_build.md)):

```sh
bloom build template.json
```

### Variables

> By default, variables are prefixed with `$`
Expand Down Expand Up @@ -121,12 +128,6 @@ It is possible to use variables inside of this syntax as well:

We welcome and appreciate contributions of any kind. Please create an issue for any proposed changes.

### Build documentation

```sh
make docs
```

## Related

- [rose-pine/build](https://github.com/rose-pine/build) - Node.js-based theme generator for Rosé Pine
23 changes: 0 additions & 23 deletions bloom_doc/bloom.md

This file was deleted.

49 changes: 0 additions & 49 deletions bloom_doc/bloom_build.md

This file was deleted.

25 changes: 0 additions & 25 deletions bloom_doc/bloom_completion.md

This file was deleted.

44 changes: 0 additions & 44 deletions bloom_doc/bloom_completion_bash.md

This file was deleted.

35 changes: 0 additions & 35 deletions bloom_doc/bloom_completion_fish.md

This file was deleted.

32 changes: 0 additions & 32 deletions bloom_doc/bloom_completion_powershell.md

This file was deleted.

46 changes: 0 additions & 46 deletions bloom_doc/bloom_completion_zsh.md

This file was deleted.

24 changes: 0 additions & 24 deletions bloom_doc/bloom_doc.md

This file was deleted.

23 changes: 0 additions & 23 deletions bloom_doc/bloom_init.md

This file was deleted.

Loading