diff --git a/README.md b/README.md index fcedfc2..859a891 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,27 @@ -sunny-overlay -============= - +# sunny-overlay Sunny-overlay is my personal Gentoo Portage overlay. Maybe it will be useful to others (we can always dream). -How to use this overlay ? -------------------------- +## How to use this overlay ? +You can use this overlay with the new portage plug-in sync system (see: https://wiki.gentoo.org/wiki/Project:Portage/Sync) or alternatively using app-portage/layman. -To use this overlay follow those steps +### New portage plug-in sync system (>=sys-apps/portage-2.2.16) + +- Add sunny-overlay's configuration +``` +# cat << EOF > /etc/portage/repos.conf/sunny-overlay.conf +[sunny-overlay] +location = /usr/local/portage/overlay/sunny-overlay +sync-type = git +sync-uri = git://github.com/dguglielmi/sunny-overlay.git +auto-sync = yes +``` +- Retrieve the overlay + +``` +# emaint sync -r sunny-overlay +``` + +### Layman users - First you need to install layman and source layman configuration from your make.conf @@ -19,17 +34,17 @@ To use this overlay follow those steps ``` # cat << EOF > /etc/layman/overlays/sunny-overlay.xml - + - - sunny-overlay - My personal Gentoo Portage overlay. - https://github.com/dguglielmi/sunny-overlay - - dg@accelance.fr - - git://github.com/dguglielmi/sunny-overlay.git - + + sunny-overlay + My personal Gentoo Portage overlay. + https://github.com/dguglielmi/sunny-overlay + + dg@accelance.fr + + git://github.com/dguglielmi/sunny-overlay.git + EOF ``` @@ -45,4 +60,3 @@ EOF ``` # layman -a sunny-overlay ``` -