CKGreeter/README.md
CanadianBaconBoi 66d90100df Add License and README, and add XDG session detection
- Updated dependencies in cargo.toml
- Added wayland-sessions and xsessions support
- Added better error handling for image and config loading
- Added some example configs
- Add FSL-1.1-MIT License
Note: All unlicensed commits prior to this commit on 17.06.2026 are considered All Rights Reserved.
2026-06-17 09:34:37 +02:00

32 lines
1.0 KiB
Markdown

# CKGreeter: Just another greeter
### A simple GreetD greeter written in Rust.
---
## Installation
### Requirements
- GreetD
- Rust/Cargo
- A Wayland compositor, **cage** is used in the example
### CKGreeter Install
- `sudo cargo install --git https://codeberg.org/CanadianBaconBoi/CKGreeter.git --bin ckgreeter --root /usr/bin`
- `sudo mkdir -p /{etc,var/cache}/ckgreeter`
- `sudo chown greetd:greetd /var/cache/ckgreeter`
### Configuring GreetD
- Add the following line to `/etc/greetd/greetd.conf`
- `command = "cage -s -d -- /usr/bin/ckgreeter"`
## Configuration
The configuration file is located at `/etc/ckgreeter/config.toml`
Example configurations can be found in [examples/config/](examples/config)
The config needs to be copied to `/etc/ckgreeter/config.toml` before the greeter can be run.
## License
- **Commits after 17.06.2026:** Licensed under the [Functional Source License, Version 1.1, MIT Future License](LICENSE.md).
- **Prior unlicensed commits (before 17.06.2026):** Copyright (c) 2026 CanadianBaconBoi. All rights reserved.