Update README.md

This commit is contained in:
TheMainOne 2020-02-08 22:12:03 +00:00
parent f930db657c
commit 4cc67cf4fb

View File

@ -1,51 +1,63 @@
# src_prepare Gentoo overlay
## What's this?
## What is this?
This is the overlay of our telegram group where we talk about Gentoo stuff (development, maintainance, mistakes, community).
This is the overlay of our Telegram group where we talk about topics related to Gentoo (development, maintainance, mistakes, community).
Do not expect high quality ebuilds, while we do the best we can, most of us are still learning.
**WARNING: Do not expect high quality ebuilds!** While we do the best we can, most of us are still learning.
A quick guide on how to test ebuilds will follow.
## Why create such overlay?
## Why create this overlay?
Mostly to have fun.
"My primary goal was to have all the ebuilds for small things for desktop "ricing" and weird ones that would not fit into the main overlay." ~XGQT
In short, we want to contribute :)
## How do I add this?
### Official list
With layman: `layman -a src_prepare-overlay`
#### Layman
or
If you are using [Layman](https://wiki.gentoo.org/wiki/Layman), execute:
With eselect-repository: `eselect repository enable src_prepare-overlay`
`layman -a src_prepare-overlay`
### Manual
#### eselect-repository
Check out [examples/repos.conf/src_prepare-overlay.conf](https://gitlab.com/src_prepare/src_prepare-overlay/blob/master/examples/repos.conf/src_prepare-overlay.conf)
If you are using [eselect-repository](https://wiki.gentoo.org/wiki/Eselect/Repository), execute:
or
`eselect repository enable src_prepare-overlay`
With layman: `layman -o 'https://gitlab.com/src_prepare/src_prepare-overlay/raw/master/repositories.xml' -f -a src_prepare-overlay`
#### Manual
If you want to manually add the overlay, see [examples/repos.conf/src_prepare-overlay.conf](https://gitlab.com/src_prepare/src_prepare-overlay/blob/master/examples/repos.conf/src_prepare-overlay.conf).
##### Layman
If you are using [Layman](https://wiki.gentoo.org/wiki/Layman), execute:
`layman -o 'https://gitlab.com/src_prepare/src_prepare-overlay/raw/master/repositories.xml' -f -a src_prepare-overlay`
## How do I sync this?
Run `sudo emaint sync -r src_prepare-overlay`
Execute:
`emaint sync -r src_prepare-overlay`
## It says the ebuild is masked, what do I do?
Check out [examples/package.accept_keywords/src_prepare-overlay](https://gitlab.com/src_prepare/src_prepare-overlay/blob/master/examples/package.accept_keywords/src_prepare-overlay)
See [examples/package.accept_keywords/src_prepare-overlay](https://gitlab.com/src_prepare/src_prepare-overlay/blob/master/examples/package.accept_keywords/src_prepare-overlay).
## I can help, what ebuilds do you need?
Check out `TODO.md`
See [TODO.md](https://gitlab.com/src_prepare/src_prepare-overlay/-/blob/master/TODO.md)
## Quick maintainer guide
### Testing ebuilds
`sudo ebuild FILE clean manifest merge`
`ebuild FILE clean manifest merge`