From 7cff9aaf5cf2f4763b238a0c669c677a9fa0ad18 Mon Sep 17 00:00:00 2001 From: Nils Freydank Date: Sat, 7 Oct 2023 18:39:15 +0200 Subject: [PATCH] Switch readme fromat from rst to asciidoc Now I prefer the latter for some details over rst. While I'm on it I changed some details like line breaks, fixing the URL on top and similar stuff. The change as based on a first migration using the awesome tool pandoc. --- README.adoc | 83 ++++++++++++++++++++++++++++++++++++++++++ README.rst | 102 ---------------------------------------------------- 2 files changed, 83 insertions(+), 102 deletions(-) create mode 100644 README.adoc delete mode 100644 README.rst diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..3527b85 --- /dev/null +++ b/README.adoc @@ -0,0 +1,83 @@ += personal gentoo overlay +:toc: + +== Main + +This is my private and unofficial https://git.holgersson.xyz/foss/holgersson-overlay[overlay] for Gentoo/Linux. +There will be different ebuilds from different sources, hopefully only temporary before submitting to the https://bugs.gentoo.org[main Gentoo bugtracker] resp. to the https://packages.gentoo.org/[main portage tree]. + +== Setup and synchronisation + +There are several possible ways of adding this overlay: + +=== Adding the overlay manually + +You can clone the repository and create `/etc/portage/repos.conf/holgersson-overlay.conf` with the following contents: + +[source,ini] +---- +[holgersson-overlay] +priority = 50 +location = /path/to/local/holgersson-overlay +sync-type = git +sync-uri = https://github.com/gentoo-mirror/holgersson-overlay.git +---- + +=== Using eselect-repository + +Run eselect repository from `app-eselect/eselect-repository`: + +[source,shell] +---- +$ eselect repository enable holgersson-overlay +---- + +=== Using layman + +Run layman from `app-portage/layman`: + +[source,shell] +---- +$ layman -a holgersson-overlay +---- + +and optional for global updates: + +[source,shell] +---- +$ layman -S +$ emerge --sync +---- + +You might want to set `USE="sync-plugin-portage"` for layman, too. + +=== Add the distfiles archive to GENTOO_MIRRORS + +You may want to optionally add the distfiles mirror of this overlay to your GENTOO_MIRRORS configuration in /etc/portage: + +[source,shell] +---- +GENTOO_MIRRORS="... https://files.holgersson.xyz/gentoo/distfiles/ ..." +---- + +The distfiles are updated daily using the tool `emirrordist` out of the portage package: + +[source,shell] +---- +emirrordist --delete --mirror --repo holgersson-overlay --distfiles +---- + +== Maintainer + +If you encounter bugs, please send a mail to *holgersson [ascii-symbol-64] posteo [ascii-symbol-46] de* or open a bug report on the https://bugs.gentoo.org[main Gentoo bugtracker] (please remember to Cc me there). +Bug descriptions, suggestions, patches, critics and chorus of praise are all welcome! + +GPG key ID: *0x8AD9 60BB A57A F797 88CC FEC0 3CAA 2CA5 14E4 EE5E* + +== License and copying + +* The contents of this document are licensed under the [.title-ref]#CC-BY-SA-3.0 license#. The ebuilds are licensed under the [.title-ref]#GNU General Public License v2# for compability with the main Gentoo/portage tree. +* Source files might have different licenses; these should be outlined in the ebuilds themselves. +* The licenses are choosen to fit into the main gentoo licenses pool; if you suggest other licenses, or think I’m mistaken in the licenses I indicate anywhere please contact me / the maintainer (see the resp. section above)! + +// vim:syntax=asciidoc:fileencoding=utf-8:ts=4:expandtab:linebreak:wrap diff --git a/README.rst b/README.rst deleted file mode 100644 index abb62b3..0000000 --- a/README.rst +++ /dev/null @@ -1,102 +0,0 @@ -.. Title: Readme for holgersson-overlay -.. Author: Nils Freydank - -Main -==== - -This is my private and unofficial overlay_ for Gentoo/Linux. -There will be different ebuilds from different sources, hopefully only temporary -before submitting to the `main Gentoo bugtracker`_ resp. to the -`main portage tree`_. - -Setup and synchronisation -========================= - -There are several possible ways of adding this overlay: - -Adding the overlay manually ---------------------------- - -You can clone the repository and create -`/etc/portage/repos.conf/holgersson-overlay.conf` with the following contents: - -.. code-block:: ini - - [holgersson-overlay] - priority = 50 - location = /path/to/local/holgersson-overlay - sync-type = git - sync-uri = https://github.com/gentoo-mirror/holgersson-overlay.git - -Using eselect-repository ------------------------- - -Run eselect repository from `app-eselect/eselect-repository`: - -.. code:: shell - - $ eselect repository enable holgersson-overlay - - -Using layman ------------- - -Run layman from `app-portage/layman`: - -.. code:: shell - - $ layman -a holgersson-overlay - -and optional for global updates: - -.. code-block:: shell - - $ layman -S - $ emerge --sync - -You might want to set `USE="sync-plugin-portage"` for layman, too. - -Add the distfiles archive to GENTOO_MIRRORS -------------------------------------------- - -You may want to optionally add the distfiles mirror of this overlay to your -GENTOO_MIRRORS configuration in /etc/portage: - -.. code:: shell - - GENTOO_MIRRORS="... https://files.holgersson.xyz/gentoo/distfiles/ ..." - -The distfiles are updated daily using the tool `emirrordist` from portage: - -.. code:: shell - - emirrordist --delete --mirror --repo holgersson-overlay --distfiles - -Maintainer -========== - -If you encounter bugs, please send a mail to -**holgersson [ascii-symbol-64] posteo [ascii-symbol-46] de** -or open a bug report on the `main Gentoo bugtracker`_ -(please remember to Cc me there). Bug descriptions, suggestions, patches, -critics and chorus of praise are all welcome! - -GPG key ID: **0x8AD9 60BB A57A F797 88CC FEC0 3CAA 2CA5 14E4 EE5E** - -License and copying -=================== - -- The contents of this document are licensed under the `CC-BY-SA-3.0 license`. - The ebuilds are licensed under the `GNU General Public License v2` for - compability with the main Gentoo/portage tree. - Source files might have - different licenses; these should be outlined in the ebuilds themselves. -- The licenses are choosen to fit into the main gentoo licenses pool; if you - suggest other licenses, or think I’m mistaken in the licenses I indicate - anywhere please contact the maintainer (see the resp. section above)! - -.. _overlay: https://git.holgersson.xyz/holgersson-overlay -.. _`main Gentoo bugtracker`: https://bugs.gentoo.org -.. _`main portage tree`: https://packages.gentoo.org/ - -.. vim:fileencoding=utf-8:ts=4:syntax=rst:colorcolumn=81