Skip to content

Commit

Permalink
docs(readme): faq about single-branch development
Browse files Browse the repository at this point in the history
  • Loading branch information
loqusion committed May 22, 2024
1 parent d002f6a commit ed39de7
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,3 +154,25 @@ exec = hyprshade auto
```

This ensures that the correct shader is enabled when you log in.

## FAQ

<!-- markdownlint-disable line-length -->

### I tried to copy something from the `examples/` or `shaders/` directory, but it's not working. What gives?

<!-- markdownlint-enable line-length -->

If you try to copy things from the `main` branch while you are using a stable
release, it may not work properly. This repository has a single-branch
development scheme, where all development is done on the `main` branch and
stable versions are [pinned with
tags](https://github.com/loqusion/hyprshade/tags). The only exception to this is
that updates to the README pertaining to unreleased features are kept on
separate branches to avoid advertising features not present in any stable
version.

If you'd like to try out unreleased features, you can use a development version
of Hyprshade — currently, the only officially supported way to do this is to use
the [`hyprshade-git` AUR
package](https://aur.archlinux.org/packages/hyprshade-git).

0 comments on commit ed39de7

Please sign in to comment.