Skip to content

Commit

Permalink
Add demo mode info to README
Browse files Browse the repository at this point in the history
  • Loading branch information
rharish101 committed Aug 3, 2024
1 parent e0e70f6 commit d3b3fef
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ These screenshots use the [Canta GTK theme](https://github.com/vinceliuice/Canta
* Respects `XDG_DATA_DIRS` environment variable
* Respects fields `Hidden` and `NoDisplay` in session files
* Picks up the first found session with the same name and in the same type (X11/Wayland). This allows for overriding system-provided session files.
* Demo mode to run ReGreet without greetd for easier development.

## Requirements
* Rust 1.64.0+ (for compilation only)
Expand Down Expand Up @@ -188,6 +189,8 @@ regreet --style /path/to/custom.css
Please refer to the GTK4 docs on [CSS in GTK](https://docs.gtk.org/gtk4/css-overview.html) and [GTK CSS Properties](https://docs.gtk.org/gtk4/css-properties.html) to learn how to style a GTK4 app using CSS.
For a general reference on CSS, please refer to the [MDN web docs](https://developer.mozilla.org/en-US/docs/Web/CSS/Syntax).

**Tip:** You might want to use [demo mode](#demo-mode) to test out your CSS before making it permanent.

### Changing Reboot/Shut Down Commands
The default reboot and shut down commands use the `reboot` and `poweroff` binaries, which are present on most Linux systems.
However, since the recommended way of using ReGreet is to avoid running it as root, the `reboot`/`poweroff` commands might not work on systems where superuser access is needed to run these commands.
Expand Down Expand Up @@ -230,6 +233,16 @@ pre-commit install
Now, pre-commit should ensure that the code passes all linters locally before committing.
This will save time when creating PRs, since these linters also run in CI, and thus fail code that hasn't been linted well.

### Demo mode
To aid development, a "demo" mode is included within ReGreet that runs ReGreet independent of greetd.
Simply run ReGreet as follows:
```sh
regreet --demo
```

Since the demo mode doesn't use greetd, authentication is done using hardcoded credentials within the codebase.
These credentials are logged with the warning log-level, so that you don't have to read the source code.

## Licenses
This repository uses [REUSE](https://reuse.software/) to document licenses.
Each file either has a header containing copyright and license information, or has an entry in the [DEP5 file](https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/) at [.reuse/dep5](./.reuse/dep5).
Expand Down

0 comments on commit d3b3fef

Please sign in to comment.