Skip to content

Commit

Permalink
feat!: overhaul repository & publish to addons store (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
sgoudham authored Aug 11, 2024
1 parent 82afeeb commit 87bb5e2
Show file tree
Hide file tree
Showing 28 changed files with 1,682 additions and 39 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: release-please

on:
workflow_dispatch:
push:
branches: [main]

permissions:
contents: write
id-token: write
pull-requests: write

jobs:
release-please:
runs-on: ubuntu-latest
steps:
- uses: googleapis/release-please-action@v4
id: release
outputs:
release_created: ${{ steps.release.outputs.release_created }}
tag_name: ${{ steps.release.outputs.tag_name }}

release:
runs-on: ubuntu-latest
needs: release-please
if: ${{ needs.release-please.outputs.release_created }}
steps:
- uses: actions/checkout@v4

- uses: extractions/setup-just@v2

- name: Build
run: just build

- name: Create Zip
run: just zip

- name: Upload Zip
env:
GH_TOKEN: ${{ github.token }}
run: gh release upload ${{ needs.release-please.outputs.tag_name }} catppuccin*.flex --clobber
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*.flex
dist
.vscode
98 changes: 60 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@


<h3 align="center">
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/logos/exports/1544x1544_circle.png" width="100" alt="Logo"/><br/>
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
Expand All @@ -8,53 +6,77 @@
</h3>

<p align="center">
<a href="https://github.com/catppuccin/floris-board/stargazers"><img src="https://img.shields.io/github/stars/catppuccin/floris-board?colorA=363a4f&colorB=b7bdf8&style=for-the-badge"></a>
<a href="https://github.com/catppuccin/floris-board/issues"><img src="https://img.shields.io/github/issues/catppuccin/floris-board?colorA=363a4f&colorB=f5a97f&style=for-the-badge"></a>
<a href="https://github.com/catppuccin/floris-board/contributors"><img src="https://img.shields.io/github/contributors/catppuccin/floris-board?colorA=363a4f&colorB=a6da95&style=for-the-badge"></a>
<a href="https://github.com/catppuccin/florisboard/stargazers"><img src="https://img.shields.io/github/stars/catppuccin/florisboard?colorA=363a4f&colorB=b7bdf8&style=for-the-badge"></a>
<a href="https://github.com/catppuccin/florisboard/issues"><img src="https://img.shields.io/github/issues/catppuccin/florisboard?colorA=363a4f&colorB=f5a97f&style=for-the-badge"></a>
<a href="https://github.com/catppuccin/florisboard/contributors"><img src="https://img.shields.io/github/contributors/catppuccin/florisboard?colorA=363a4f&colorB=a6da95&style=for-the-badge"></a>
</p>

<p align="center">
<img src="assets/floris.png" alt="Screenshot" width="700">
<p float="left">
<img src="assets/bordered/preview_bordered.webp" alt="Bordered Preview" width=400>
<img src="assets/borderless/preview_borderless.webp" alt="Borderless Preview" width=400>
</p>


## USAGE

1. Download the file ([Releases](https://github.com/catppuccin/floris-board/releases/latest))
2. Open the app
3. Click on Theme
4. Click on `Manage Installed Themes`
5. Import
6. Click on `Select files`
7. Select the file in the file manager
8. It will display the theme info and click on `Import`
9. Select the flavour you want!

## 🙋 FAQ

- **_"More about the App"_**
- The github for the app is [here](https://github.com/florisboard/florisboard)

- **_"Which flavours does it comes with?"_**
- It comes with all 4 currently available flavours (Latte,Macchiato,Mocha and Frappe) with bordered and borderless versions and it also comes with a special Catppuccin 1.0 theme as well!

- **_"I want to change the Enter key colour"_**
- See Editing Instruction

## Editing the theme

Go to `Manage Installed Themes` , Click on `Edit` under Catppuccin and then edit your desired colorscheme.

To change the enter key colour , set the `Primary Color` key to your desired color and if you want to make it match the background(make it borderless) then change `Key code = [10]` value from `Primary Color` to `Common Surface`
## Previews

<details>
<summary>🌻 Latte</summary>
<img src="assets/bordered/latte_bordered.webp" height="500"/>
<img src="assets/borderless/latte_borderless.webp" height="500"/>
</details>
<details>
<summary>🪴 Frappé</summary>
<img src="assets/bordered/frappe_bordered.webp" height="500"/>
<img src="assets/borderless/frappe_borderless.webp" height="500"/>
</details>
<details>
<summary>🌺 Macchiato</summary>
<img src="assets/bordered/macchiato_bordered.webp" height="500"/>
<img src="assets/borderless/macchiato_borderless.webp" height="500"/>
</details>
<details>
<summary>🌿 Mocha</summary>
<img src="assets/bordered/mocha_bordered.webp" height="500"/>
<img src="assets/borderless/mocha_borderless.webp" height="500"/>
</details>

## Usage

### Add-ons Store (Recommended)

1. Visit the [FlorisBoard Add-ons Store](https://beta.addons.florisboard.org/).
2. Search for `Catppuccin`.
3. Click download and import the extension with the FlorisBoard app.

### Manual

1. Download the `.flex` file from [GitHub Releases](https://github.com/catppuccin/florisboard/releases/latest).
2. Open the FlorisBoard app.
3. Click `Addons & Extensions`.
4. Click `Import`.
5. Select the downloaded `.flex` file.
6. After verifying that you can see list of Catppuccin themes, click `Import`.
7. Head back to the main menu, click `Theme`, and select the Catppuccin theme you want to use for both Day and Night mode.

## Editing the Theme

1. Go to `Addons & Extensions` in FlorisBoard app.
2. Click `Theme extensions`.
3. Press `Edit` on Catppuccin.
4. Edit your desired flavour(s).

For example, to change the enter key colour, set the `Primary Color` key to your
desired color.

If you want to make it match the background (i.e. make it borderless) then
change `Key code = [10]` value from `Primary Color` to `Common Surface`

## 💝 Thanks to

- [Mirage](https://github.com/skinatro)
- [winston](https://github.com/nekowinston)
- [winston](https://github.com/nekowinston)

&nbsp;

<p align="center"><img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/footers/gray0_ctp_on_line.svg?sanitize=true" /></p>
<p align="center">Copyright &copy; 2021-present <a href="https://github.com/catppuccin" target="_blank">Catppuccin Org</a>
<p align="center"><a href="https://github.com/catppuccin/catppuccin/blob/main/LICENSE"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8"/></a></p>

1 change: 0 additions & 1 deletion assets/Floris-Catppuccin.json

This file was deleted.

Binary file removed assets/asset.png
Binary file not shown.
Binary file added assets/bordered/frappe_bordered.webp
Binary file not shown.
Binary file added assets/bordered/latte_bordered.webp
Binary file not shown.
Binary file added assets/bordered/macchiato_bordered.webp
Binary file not shown.
Binary file added assets/bordered/mocha_bordered.webp
Binary file not shown.
Binary file added assets/bordered/preview_bordered.webp
Binary file not shown.
Binary file added assets/borderless/frappe_borderless.webp
Binary file not shown.
Binary file added assets/borderless/latte_borderless.webp
Binary file not shown.
Binary file added assets/borderless/macchiato_borderless.webp
Binary file not shown.
Binary file added assets/borderless/mocha_borderless.webp
Binary file not shown.
Binary file added assets/borderless/preview_borderless.webp
Binary file not shown.
Binary file removed assets/floris.png
Binary file not shown.
Binary file removed catpuccin.themes.1659370514314.flex
Binary file not shown.
22 changes: 22 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
set export

_default:
@just --list

version := `jq '.meta.version' src/extension.json | tr -d '"'`

# Remove the './dist' directory
clean:
rm -rfv ./dist

# Minify JSON files and put source files into "./dist"
build:
mkdir -p dist/stylesheets
cat src/extension.json | jq -c > dist/extension.json
for file in `ls src/stylesheets`; do \
cat src/stylesheets/$file | jq -c > dist/stylesheets/$file; \
done

# Zip "./dist" into the "./flex" format
zip:
cd dist && zip -r ../catppuccin-{{version}}.flex .
16 changes: 16 additions & 0 deletions release-please-config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
"packages": {
".": {
"package-name": "",
"release-type": "simple",
"extra-files": [
{
"type": "json",
"path": "src/extension.json",
"jsonpath": "$.meta.version"
}
]
}
}
}
82 changes: 82 additions & 0 deletions src/extension.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
{
"$": "ime.extension.theme",
"meta": {
"id": "com.catppuccin.florisboard",
"version": "0.0.1",
"title": "Catppuccin",
"description": "🥀 Soothing pastel theme for FlorisBoard",
"keywords": [
"pastel catppuccin mocha latte frappe macchiato"
],
"homepage": "https://github.com/catppuccin/florisboard",
"issueTracker": "https://github.com/catppuccin/florisboard/issues",
"maintainers": [
"skinatro"
],
"license": "MIT"
},
"themes": [
{
"id": "ctp_latte",
"label": "Latte",
"authors": [
"skinatro"
],
"isNight": false
},
{
"id": "ctp_latte_borderless",
"label": "Latte (Borderless)",
"authors": [
"skinatro"
],
"isNight": false,
"isBorderless": true
},
{
"id": "ctp_mocha",
"label": "Mocha",
"authors": [
"skinatro#"
]
},
{
"id": "ctp_mocha_borderless",
"label": "Mocha (Borderless)",
"authors": [
"skinatro"
],
"isBorderless": true
},
{
"id": "ctp_frappe",
"label": "Frappe",
"authors": [
"skinatro"
]
},
{
"id": "ctp_frappe_borderless",
"label": "Frappe (Borderless)",
"authors": [
"skinatro"
],
"isBorderless": true
},
{
"id": "ctp_macchiato",
"label": "Macchiato",
"authors": [
"skinatro"
]
},
{
"id": "ctp_macchiato_borderless",
"label": "Macchiato (Borderless)",
"authors": [
"skinatro"
],
"isBorderless": true
}
]
}
Loading

0 comments on commit 87bb5e2

Please sign in to comment.