gentoo-overlay/README.md

56 lines
2.6 KiB
Markdown
Raw Normal View History

# fritteli's Gentoo overlay
2015-10-05 10:24:15 +02:00
Gentoo overlay with some ebuilds that I found either outdated or missing in the official repository or in other overlays. Ebuilds are usually removed from this overlay whenever I find a version available in the official tree or in another overlay (provided I'm satisfied with them).
2014-01-21 18:29:34 +01:00
2023-06-16 22:23:46 +02:00
Build status of the [main branch](https://gittr.ch/linux/gentoo-overlay/src/branch/main), as seen by `pkgcheck scan --exit error --net .`: [![Build Status](https://ci.gittr.ch/api/badges/linux/gentoo-overlay/status.svg?ref=refs/heads/main)](https://ci.gittr.ch/linux/gentoo-overlay)
2014-01-21 18:29:34 +01:00
## Using with plain (recent) Portage
Create a new config file under `/etc/portage/repos.conf/fritteli.conf` with the following contents:
[fritteli]
auto-sync = yes
location = /usr/local/portage/overlays/fritteli
sync-type = git
sync-uri = https://gittr.ch/linux/gentoo-overlay.git
You may adapt the `location` attribute to your system's own setup.
2024-03-30 10:38:45 +01:00
If you prefer to use the overlay hosted at GitHub (which tends to be more stable but less up-to-date than the one hosted at gittr.ch), you may use `https://github.com/fritteli/gentoo-overlay.git` for the `sync-uri`.
## Using with Layman
2014-01-21 18:29:34 +01:00
2018-06-22 02:15:34 +02:00
You may also use [`layman`](https://wiki.gentoo.org/wiki/Layman) to manage this overlay. If you choose this method, you will be using the overlay hosted at GitHub.
2014-01-21 18:29:34 +01:00
2019-05-03 12:18:53 +02:00
For detailed information regarding layman, please refer to the [official documentation](https://wiki.gentoo.org/wiki/Layman). This section only covers the process in a very brief manner.
2014-01-21 18:29:34 +01:00
2019-05-03 12:18:53 +02:00
If you haven't used layman yet, just install it running this command:
USE="git sync-plugin-portage" emerge layman
2014-01-21 18:29:34 +01:00
Then you can add this overlay wih:
2018-06-22 02:15:34 +02:00
layman -a fritteli
2018-06-22 02:15:34 +02:00
You will be prompted for confirmation because this is an experimental overlay. Just continue by hitting `y`.
2014-01-21 18:29:34 +01:00
Keep the overlay up to date from Git:
layman -s fritteli
## Bug reports and ebuild requests
2018-06-22 02:15:34 +02:00
If you find a bug in an ebuild, encounter a build error or would like me to add a new ebuild, please open an issue on [GitHub](https://github.com/fritteli/gentoo-overlay/issues) or on [gittr.ch](https://gittr.ch/linux/gentoo-overlay/issues).
## Contributing
2018-06-22 02:15:34 +02:00
I gladly accept pull requests for bugs or new ebuilds. Before opening a pull request, please make sure your changes don't upset [`pkgcheck`](https://wiki.gentoo.org/wiki/Pkgcheck). Run the following command and fix warnings and errors:
2018-06-22 02:15:34 +02:00
pkgcheck scan --net .
2018-06-22 02:15:34 +02:00
## Maintainers
2014-01-21 18:29:34 +01:00
* [Manuel Friedli](mailto:manuel@fritteli.ch)
## Acknowledgements
2014-01-21 18:29:34 +01:00
2018-06-22 02:15:34 +02:00
Thanks go to Jakub Jirutka, the maintainer of the [CVUT Overlay](https://github.com/cvut/gentoo-overlay), from whom I shamelessly copied this README.md for a start.