https://github.com/beatussum/eselect-hypr-dotfiles
Manage Hyprland dotfiles via eselect
https://github.com/beatussum/eselect-hypr-dotfiles
eselect gentoo hyprland
Last synced: about 1 year ago
JSON representation
Manage Hyprland dotfiles via eselect
- Host: GitHub
- URL: https://github.com/beatussum/eselect-hypr-dotfiles
- Owner: beatussum
- License: gpl-3.0
- Created: 2024-06-19T14:40:53.000Z (almost 2 years ago)
- Default Branch: develop
- Last Pushed: 2024-07-19T18:05:11.000Z (almost 2 years ago)
- Last Synced: 2025-01-23T11:42:53.502Z (over 1 year ago)
- Topics: eselect, gentoo, hyprland
- Language: Shell
- Homepage:
- Size: 121 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# eselect-hypr-dotfiles
[](LICENSE)
[](https://github.com/beatussum/eselect-hypr-dotfiles/releases/)
[](https://github.com/beatussum/eselect-hypr-dotfiles/actions/workflows/run-tests.yml/)
[](https://codecov.io/gh/beatussum/eselect-hypr-dotfiles/)
## Table of contents
- [What is `eselect hypr-dotfiles`?](#what-is-eselect-hypr-dotfiles)
- [Building](#building)
- [Dependencies](#dependencies)
- [Building process](#building-process)
- [Licenses](#licenses)
## What is `eselect hypr-dotfiles`?
[**`eselect hypr-dotfiles`**](https://github.com/beatussum/eselect-hypr-dotfiles/) is an [`eselect`](https://wiki.gentoo.org/wiki/Project:Eselect) module for managing [Hyprland](https://hyprland.org/) dotfiles (licensed under GPL-3 or any later version).
## Building
### Dependencies
- `dev-util/kcov`: only needed for coverage.
- `dev-util/shellspec`[^1]: only needed for testing and coverage.
- `dev-vcs/git`: only needed for building.
All other dependencies are already included in **@system**.
### Building process
1. Clone the repository.
```sh
git clone "https://github.com/beatussum/eselect-hypr-dotfiles.git"
```
1. **(optional)** Test the program.
```sh
make -C eselect-hypr-dotfiles test
```
The JUnit report file is at `build/report/results_junit.xml`.
1. **(optional)** Compute code coverage.
```sh
make -C eselect-hypr-dotfiles coverage
```
The output files are in `build/coverage/`.
1. Install the program.
```sh
sudo make -C eselect-hypr-dotfiles DESTDIR= PREFIX= install
```
## Licenses
As explained above, the code of this software is licensed under GPL-3 or any later version. Details of the rights applying to the various third-party files are described in the [copyright](copyright) file in [the Debian `debian/copyright` file format](https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/).
[^1]: You can emerge this package by using [my personnal overlay](https://github.com/beatussum/beatussum-overlay/).