diff options
| -rw-r--r-- | README.md | 63 |
1 files changed, 36 insertions, 27 deletions
diff --git a/README.md b/README.md index 2c1bcb7..d9da06b 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,24 @@ [](https://travis-ci.org/azahi/ricerlay) +> Starting from September 2021 I've fully shifted my focus to NixOS and no +> longer have Gentoo Linux installed on any of my machines, thus making me a tad +> inactive in the Gentoo world. I'm still willing to "passively" maintain this +> repository through Pull Requests and Issues on GitHub but don't expect timely +> versions bumps and fixes for build errors from now on. Unless there are big +> breaking changes upstream you can still use live builds (*-9999) of packages +> to get something up-to-date. I'm not going to delete this overlay from +> Gentoo's official list because as of 2021/10/23 there are still more than a +> hundred unique clones per week. + ## Purpose -The main Gentoo package tree sometimes lacks *crucial* packages -for ricing. Some of them do exist but, for example, live ebuilds are not -present or broken. This overlay is aimed to fix these issues and promote -Gentoo as a favorable distribution for those who want to customize their -desktop, without polluting and going through a hassle of adding packages -to the main tree (read as: *to avoid responsibility*). +The main Gentoo package tree sometimes lacks *crucial* packages for ricing. Some +of them do exist but, for example, live ebuilds are not present or broken. This +overlay is aimed to fix these issues and promote Gentoo as a favourable +distribution for those who want to customise their desktop, without polluting +and going through a hassle of adding packages to the main tree (read as: *to +avoid responsibility*). ## Installing and Using @@ -33,24 +43,24 @@ emerge <package> Please do contribute! -If you are willing to help, there is a `TODO.md` list that contains -packages needed to be added or updated. However, you are not limited to -only working with it. You are encouraged to add interesting packages -related to ricing, customization and workflow improvement. +If you are willing to help, there is a `TODO.md` list that contains packages +needed to be added or updated. However, you are not limited to only working with +it. You are encouraged to add interesting packages related to ricing, +customisation and workflow improvement. Some packages here I no longer use or maybe even too lazy to bump to upstream versions. Please report any issues rearding that. ### Making PRs -Make sure you are familiar with how to write and how to format ebuilds -and ebuild repositories. The Gentoo's official and up-to-date guide can -be found [here](https://devmanual.gentoo.org/ebuild-writing/index.html). -In addition, to make a good PR that will surely get accepted, I recommend -reading [this](https://wiki.gentoo.org/wiki/GitHub_Pull_Requests). +Make sure you are familiar with how to write and how to format ebuilds and +ebuild repositories. The Gentoo's official and up-to-date guide can be found +[here](https://devmanual.gentoo.org/ebuild-writing/index.html). In addition, to +make a good PR that will surely get accepted, I recommend reading +[this](https://wiki.gentoo.org/wiki/GitHub_Pull_Requests). -Example workflow could look like this (commented out are actions that -you perform outside of your shell): +Example workflow could look like this (commented out are actions that you +perform outside of your shell): ``` text ### Fork this repository ### @@ -64,10 +74,9 @@ git push -f origin master ### Create a PR ### ``` -Consider commiting changes *per-package*, **don't** commit multiple -packages at once. Make sure you write a **meaningful commit message** -(you can use two or three words if you think that changes are -self-explanatory), for example: +Consider committing changes *per-package*, **don't** commit multiple packages at +once. Make sure you write a **meaningful commit message** (you can use two or +three words if you think that changes are self-explanatory), for example: ``` text some-category/some-package: Briefly state yor changes @@ -81,8 +90,8 @@ are working on a fix, for example: Bug #420, Fixes #69. Check your changes with `app-portage/repoman` and `app-portage/overlint` for possible QA errors. -If you are submiting a new package, include yourself as a maintainer in -the `metadata.xml` file, for example: +If you are submitting a new package, include yourself as a maintainer in the +`metadata.xml` file, for example: ``` xml <?xml version="1.0" encoding="UTF-8"?> @@ -95,10 +104,10 @@ the `metadata.xml` file, for example: </pkgmetadata> ``` -And finally, consider using indentation guides from `.editorconfig` file -so that the code in the overlay stays uniform. In short, both `.ebuild` -and `.xml` files are using tabs. You are free to do what you consider the best -in the `${FILESDIR}` with patches and whatnot. +And finally, consider using indentation guides from `.editorconfig` file so that +the code in the overlay stays uniform. In short, both `.ebuild` and `.xml` files +are using tabs. You are free to do what you consider the best in the +`${FILESDIR}` with patches and whatnot. ## Links |