Merge pull request #27 from catppuccin/ci/release

add release ci

.github/workflows/build-release.yml

@@ -0,0 +1,28 @@
+name: Build and Release
+
+permissions:
+  contents: write
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Just
+        run: sudo snap install --edge --classic just
+
+      - name: Build and Package
+        run: just zip
+
+      - name: Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*.zip

.gitignore

@@ -0,0 +1 @@
+dist/

README.md

@@ -37,10 +37,9 @@
 ## Usage
 
 1. Ensure you have the [dependencies](#dependencies).
-2. Clone this repository locally.
-3. Go into the _src_ directory then copy the folder catppuccin-flavour (flavour is replaced with latte/frappe/macchiato/mocha).
-4. Paste the folder to `/usr/share/sddm/themes/`
-5. Edit the file in `/etc/sddm.conf/` and change the theme in there from whatever was before to catppuccin-flavour.
+2. Get your preferred theme from the [releases page](https://github.com/catppuccin/sddm/releases).
+3. Unzip the contents of the release into `/usr/share/sddm/themes/`
+4. Edit the file in `/etc/sddm.conf/` and change the theme in there to `catppuccin-<flavour>`. For example, `catppuccin-mocha`.
 
 - If you don't have this file make one with `.conf` extension and make sure it has these two lines within the config:
 
@@ -54,25 +53,25 @@ Current=catppuccin-flavour
 ### Arch Based OS
 
 ```bash
-pacman -Syu qt5-graphicaleffects qt5-svg qt5-quickcontrols2
+pacman -Syu qt5-svg qt5-quickcontrols2
 ```
 
 ### Debian Based OS
 
 ```bash
-apt install --no-install-recommends qml-module-qtquick-layouts qml-module-qtgraphicaleffects qml-module-qtquick-controls2 libqt5svg5
+apt install --no-install-recommends qml-module-qtquick-layouts qml-module-qtquick-controls2 libqt5svg5
 ```
 
 ### RPM Based OS
 
 ```bash
-dnf install qt5-qtgraphicaleffects qt5-qtquickcontrols2 qt5-qtsvg
+dnf install qt5-qtquickcontrols2 qt5-qtsvg
 ```
 
 ### Solus OS
 
 ```bash
-eopkg install qt5-graphicaleffects qt5-quickcontrols2 qt5-svg
+eopkg install qt5-quickcontrols2 qt5-svg
 ```
 
 ## Configuration

justfile

@@ -0,0 +1,35 @@
+_default:
+  @just --list
+
+output_dir := "dist"
+
+# Remove output directory
+clean:
+  rm -rfv {{output_dir}}
+
+_build flavor:
+  # make sure the directories we need exist
+  mkdir -p "{{output_dir}}/catppuccin-{{flavor}}"
+
+  # copy the files to the correct location
+  cp -r src/* "{{output_dir}}/catppuccin-{{flavor}}"
+
+  # replace the theme name in the metadata file
+  sed -i -e "s/%%THEME%%/{{flavor}}/g" "{{output_dir}}/catppuccin-{{flavor}}/metadata.desktop"
+
+  # handle items that are different per theme
+  cp "pertheme/{{flavor}}.png" "{{output_dir}}/catppuccin-{{flavor}}/preview.png"
+  cp "pertheme/{{flavor}}.conf" "{{output_dir}}/catppuccin-{{flavor}}/theme.conf"
+
+# Build theme
+build: clean (_build "latte") (_build "frappe") (_build "macchiato") (_build "mocha")
+
+_zip flavor:
+  zip -r {{output_dir}}/catppuccin-{{flavor}}.zip {{output_dir}}/catppuccin-{{flavor}}
+
+# Generate zips
+zip: build (_zip "latte") (_zip "frappe") (_zip "macchiato") (_zip "mocha")
+
+# Install themes
+install: build
+  cp -r {{output_dir}}/catppuccin-* /usr/share/sddm/themes/