readme: rename outfoxxed-quickshell.scm -> quickshell.scm

* quickshell.scm: Rename from outfoxxed-quickshell.scm.
Change distributor.
Fix broken indentation.
* .editorconfig: Add .scm filetype
* readme.md: Update and move Guix entry.
This commit is contained in:
Andrew Wong 2025-03-24 23:31:11 -04:00
parent 8ac8259823
commit 39b463959e
3 changed files with 32 additions and 27 deletions

View file

@ -13,3 +13,6 @@ indent_size = 2
[*.{yml,yaml}] [*.{yml,yaml}]
indent_style = space indent_style = space
indent_size = 2 indent_size = 2
[*.scm]
indent_style = space

View file

@ -22,20 +22,6 @@ Commits with breaking qml api changes will contain a `!` at the end of the scope
# Installation # Installation
## Guix
This repo works as a channel. Add the following to your channel list:
```scheme
(channel
(name 'outfoxxed-quickshell)
(url "https://git.outfoxxed.me/outfoxxed/quickshell")
(branch "master"))
```
You can also clone the repository and use `guix shell -f outfoxxed-quickshell.scm` to try out the package.
Quickshell will be packaged upstream after the first versioned release.
## Nix ## Nix
This repo has a nix flake you can use to install the package directly: This repo has a nix flake you can use to install the package directly:
@ -92,6 +78,20 @@ It is not managed by us and should be looked over before use.
[Fedora COPR package]: https://copr.fedorainfracloud.org/coprs/errornointernet/quickshell [Fedora COPR package]: https://copr.fedorainfracloud.org/coprs/errornointernet/quickshell
## Guix
This repo works as a channel. Add the following to your channel list:
```scheme
(channel
(name quickshell)
(url "https://git.outfoxxed.me/outfoxxed/quickshell")
(branch "master"))
```
Then, you can install the package via `guix install quickshell-git` or by adding `quickshell-git` to your system or home definition.
You can also clone the repository and use `guix shell -f quickshell.scm` to try out the package.
## Anything else ## Anything else
See [BUILD.md](BUILD.md) for instructions on building and packaging quickshell. See [BUILD.md](BUILD.md) for instructions on building and packaging quickshell.

View file

@ -1,4 +1,4 @@
(define-module (outfoxxed-quickshell) (define-module (quickshell)
#:use-module ((guix licenses) #:prefix license:) #:use-module ((guix licenses) #:prefix license:)
#:use-module (gnu packages cpp) #:use-module (gnu packages cpp)
#:use-module (gnu packages freedesktop) #:use-module (gnu packages freedesktop)
@ -25,17 +25,17 @@
(name "quickshell") (name "quickshell")
(version "git") (version "git")
(source (local-file "." "quickshell-checkout" (source (local-file "." "quickshell-checkout"
#:recursive? #t #:recursive? #t
#:select? (or (git-predicate (current-source-directory)) #:select? (or (git-predicate (current-source-directory))
(const #t)))) (const #t))))
(build-system cmake-build-system) (build-system cmake-build-system)
(propagated-inputs (list qtbase qtdeclarative qtsvg)) (propagated-inputs (list qtbase qtdeclarative qtsvg))
(native-inputs (list ninja (native-inputs (list ninja
gcc-14
pkg-config pkg-config
qtshadertools qtshadertools
spirv-tools spirv-tools
wayland-protocols wayland-protocols))
gcc-14))
(inputs (list cli11 (inputs (list cli11
jemalloc jemalloc
libdrm libdrm
@ -44,24 +44,26 @@
linux-pam linux-pam
mesa mesa
pipewire pipewire
qtbase
qtdeclarative qtdeclarative
qtwayland qtwayland
vulkan-headers vulkan-headers
wayland wayland))
qtbase))
(arguments (arguments
(list #:tests? #f (list #:tests? #f
#:configure-flags #~(list "-GNinja" #:configure-flags
"-DDISTRIBUTOR=\"GNU Guix\"" #~(list "-GNinja"
"-DDISTRIBUTOR_DEBUGINFO_AVAILABLE=NO" "-DDISTRIBUTOR=\"In-tree Guix channel\""
"-DCRASH_REPORTER=OFF") ;no breakpad "-DDISTRIBUTOR_DEBUGINFO_AVAILABLE=NO"
;; Breakpad is not currently packaged for Guix.
"-DCRASH_REPORTER=OFF")
#:phases #~(modify-phases %standard-phases #:phases #~(modify-phases %standard-phases
(replace 'build (replace 'build
(lambda* (#:key parallel-build? #:allow-other-keys) (lambda* (#:key parallel-build? #:allow-other-keys)
(invoke "cmake" "--build" "."))) (invoke "cmake" "--build" ".")))
(replace 'install (replace 'install
(lambda _ (invoke "cmake" "--install" ".")))))) (lambda _ (invoke "cmake" "--install" "."))))))
(home-page "https://git.outfoxxed.me/quickshell/quickshell") (home-page "https://quickshell.outfoxxed.me")
(synopsis "QtQuick-based desktop shell toolkit") (synopsis "QtQuick-based desktop shell toolkit")
(description (description
"Quickshell is a flexible QtQuick-based toolkit for creating and "Quickshell is a flexible QtQuick-based toolkit for creating and