src_prepare-overlay/README.md

106 lines
3.5 KiB
Markdown
Raw Normal View History

2020-07-27 22:22:27 +02:00
<p align="center">
<a href="https://gitlab.com/src_prepare/src_prepare-overlay/pipelines">
2020-08-11 04:57:55 +02:00
<img src="https://gitlab.com/src_prepare/src_prepare-overlay/badges/master/pipeline.svg">
2020-07-27 22:22:27 +02:00
</a>
<a href="https://gentoo.org/">
2020-08-11 04:57:55 +02:00
<img src="https://gitlab.com/src_prepare/badge/-/raw/master/powered-by-gentoo-linux-tyrian.svg">
2020-07-27 22:22:27 +02:00
</a>
2020-08-11 04:57:55 +02:00
<a href="./LICENSE">
<img src="https://img.shields.io/badge/license-GPLv2-blue.svg">
2020-07-27 22:22:27 +02:00
</a>
2020-07-27 22:46:19 +02:00
<a href="https://app.element.io/#/room/#src_prepare:matrix.org">
2020-08-11 04:57:55 +02:00
<img src="https://gitlab.com/src_prepare/badge/-/raw/master/chat-matrix-blue.svg">
2020-07-27 22:22:27 +02:00
</a>
<a href="https://gitlab.com/src_prepare/src_prepare-overlay/commits/master.atom">
2020-08-11 04:57:55 +02:00
<img src="https://gitlab.com/src_prepare/badge/-/raw/master/feed-atom-orange.svg">
2020-07-27 22:22:27 +02:00
</a>
</p>
2019-12-27 22:21:49 +01:00
# src_prepare Gentoo overlay
2020-05-14 03:13:05 +02:00
This is the overlay of our Matrix group where we talk about topics related to Gentoo (development, maintainance, support, communities and more).
2019-12-27 22:21:49 +01:00
2020-02-08 23:12:03 +01:00
**WARNING: Do not expect high quality ebuilds!** While we do the best we can, most of us are still learning.
2019-12-27 22:21:49 +01:00
A quick guide on how to test ebuilds will follow.
2020-02-08 23:12:03 +01:00
## Why create this overlay?
2019-12-27 22:21:49 +01:00
Mostly to have fun.
## For whom?
src_prepare overlay was based on a concept of [GURU](https://wiki.gentoo.org/wiki/Project:GURU) with the following exceptions:
- easier to get access to the master branch
- main contact with the src_prepare project is via [Matrix](https://matrix.to/#/#src_prepare:matrix.org)
- main git repo is hosted on [Gitlab](https://gitlab.com/src_prepare/src_prepare-overlay) with [Github](https://github.com/xgqt/src_prepare-overlay) and [Codeberg](https://codeberg.org/src_prepare/src_prepare-overlay) mirrors
- more freedom in creating ebuilds
- no requirement for GPG keys
- no requirement for private info
src_prepare project doesn't want to overtake the GURU project, the course that the GURU project takes is more professional, src_prepare overlay is more open for ebuilds:
- binary packages from upstream
- from inexperienced users
- from software created by the src_prepare project itself
- live ebuilds
- programs that run under WINE (or other emulators)
## Adding the overlay
2019-12-27 22:21:49 +01:00
### Official list
2020-02-08 23:12:03 +01:00
#### Layman
If you are using [Layman](https://wiki.gentoo.org/wiki/Layman), execute:
2020-02-25 20:27:20 +01:00
``` sh
layman -a src_prepare-overlay
```
2020-02-08 23:12:03 +01:00
#### eselect-repository
2020-02-08 23:12:03 +01:00
If you are using [eselect-repository](https://wiki.gentoo.org/wiki/Eselect/Repository), execute:
2020-02-25 20:27:20 +01:00
``` sh
eselect repository enable src_prepare-overlay
```
2020-02-08 23:12:03 +01:00
#### Manual
2019-12-27 22:21:49 +01:00
2020-02-08 23:12:03 +01:00
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).
2020-02-08 23:12:03 +01:00
##### Layman
If you are using [Layman](https://wiki.gentoo.org/wiki/Layman), execute:
2020-02-25 20:27:20 +01:00
``` sh
layman -o 'https://gitlab.com/src_prepare/src_prepare-overlay/raw/master/repositories.xml' -f -a src_prepare-overlay
```
2019-12-27 22:21:49 +01:00
## How do I sync this?
2020-02-08 23:12:03 +01:00
Execute:
2020-02-25 20:27:20 +01:00
``` sh
emaint sync -r src_prepare-overlay
```
2019-12-27 22:21:49 +01:00
## It says the ebuild is masked, what do I do?
2020-02-08 23:12:03 +01:00
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).
2019-12-27 22:21:49 +01:00
## Contributing
2020-04-03 18:18:53 +02:00
We appreciate and encourage for contribution. If you want a specific package or want to create a package for us to maintain, see [CONTRIBUTING.md](/CONTRIBUTING.md).
2019-12-27 22:21:49 +01:00
## Quick maintainer guide
### Testing ebuilds
2020-02-25 20:27:20 +01:00
``` sh
repoman manifest
ebuild FILE clean merge
2020-02-25 20:27:20 +01:00
```