diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cbe0b27..b3a6258 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,8 +6,9 @@ requests. So, go over to GitHub and fork this repository: After you're done, please make sure that your changes don't upset [`pkgcheck`](https://wiki.gentoo.org/wiki/Pkgcheck). Run the following command and fix warnings and errors: - - pkgcheck scan --exit error,warning,style --net . +```commandline +pkgcheck scan --exit error,warning,style --net . +``` Then send me the pull request. If you want, you can also create an issue along with it. But you don't have to. diff --git a/README.md b/README.md index 0315310..f8da048 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,48 @@ # fritteli's Gentoo overlay -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). +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). -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) +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) -## Using with plain (recent) Portage -Create a new config file under `/etc/portage/repos.conf/fritteli.conf` with the following contents: +## Using this overlay +Just execute these commands: +```commandline +eselect repository enable fritteli +emaint -r fritteli sync +``` - [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. - -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 - -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. - -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. - -If you haven't used layman yet, just install it running this command: - - USE="git sync-plugin-portage" emerge layman - -Then you can add this overlay wih: - - layman -a fritteli - -You will be prompted for confirmation because this is an experimental overlay. Just continue by hitting `y`. - -Keep the overlay up to date from Git: - - layman -s fritteli +In case this doesn't work, it might be because of a recent rename of the +`master` branch to `main`. In that case, execute the following commands. +**NOTE**: You will be using the latest and most recent development version +of the overlay. But that does no harm. +```commandline +eselect repository add fritteli git https://gittr.ch/linux/gentoo-overlay.git +emaint -r fritteli sync +``` +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` as the URL. ## Bug reports and ebuild requests -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). +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). ## Contributing -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: - - pkgcheck scan --net . +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 +in the directory of the ebuild and fix warnings and errors: +```commandline +pkgcheck scan --net . +``` ## Maintainers @@ -52,4 +50,6 @@ I gladly accept pull requests for bugs or new ebuilds. Before opening a pull req ## Acknowledgements -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. +Thanks go to Jakub Jirutka, the maintainer of the (now defunct) +[CVUT Overlay](https://github.com/cvut/gentoo-overlay), from whom I shamelessly +copied this README.md for a start. diff --git a/layman.xml b/layman.xml deleted file mode 100644 index 2282321..0000000 --- a/layman.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - - - fritteli - fritteli's overlay of Gentoo ebuilds - https://gittr.ch/linux/gentoo-overlay - - manuel@fritteli.ch - Manuel Friedli - - https://gittr.ch/linux/gentoo-overlay.git - -