sci-mathematics/gimps: improve documentation for first time users.

Gentoo-Bug: 603408

Signed-off-by: Michael Orlitzky <mjo@gentoo.org>

diff --git a/sci-mathematics/gimps/files/README.gentoo b/sci-mathematics/gimps/files/README.gentoo
new file mode 100644 (file)
index 0000000..d85d77b
--- /dev/null
+++ b/sci-mathematics/gimps/files/README.gentoo
@@ -0,0 +1,25 @@
+Useful documentation for running the GIMPS daemon can be found at:
+http://www.mersenne.org/gettingstarted/
+http://www.mersenneforum.org/forumdisplay.php?f=10
+
+To run the GIMPS daemon as an unprivileged user some steps are required.
+
+1. Before starting the GIMPS service run (as root) the following command:
+  # /opt/gimps/mprime -m -w/var/lib/gimps
+2. Answer 'Y' to the "Join Gimps?" question
+3. Accept default values for the following question (or tweak them as you
+deem necessary)
+4. Stop the running tests with ^C
+5. Exit the client, pressing '5'
+6. Change the owner and group of all the files in /var/lib/gimps to
+nobody:nobody:
+  # chown nobody:nobody /var/lib/gimps/*
+
+Then you can use `/etc/init.d/gimps start` to start a GIMPS client in the
+background at boot. Have a look at /etc/conf.d/gimps and check some
+configuration options.
+                               
+If you don't want to use the init script to start gimps, remember to
+pass it an additional command line parameter specifying where the data
+files are to be stored, e.g.:
+# /opt/gimps/mprime -w/var/lib/gimps"

diff --git a/sci-mathematics/gimps/gimps-28.10-r1.ebuild b/sci-mathematics/gimps/gimps-28.10-r1.ebuild
index 34a48f2091c0315c554e8a346d6c79a74059f0ba..16e14828c63fd1b4a1d6050d2ed2d9fe53950342 100644 (file)
--- a/sci-mathematics/gimps/gimps-28.10-r1.ebuild
+++ b/sci-mathematics/gimps/gimps-28.10-r1.ebuild
@@ -4,7 +4,7 @@
 
 EAPI=6
 
-inherit pax-utils systemd
+inherit pax-utils systemd readme.gentoo-r1
 
 DESCRIPTION="The Great Internet Mersenne Prime Search"
 HOMEPAGE="http://mersenne.org/"
@@ -40,6 +40,8 @@ src_install() {
 
        einstalldocs
 
+       readme.gentoo_create_doc
+
        newinitd "${FILESDIR}/${PN}-28.9-init.d" gimps
        newconfd "${FILESDIR}/${PN}-25.6-conf.d" gimps
 
@@ -48,16 +50,7 @@ src_install() {
 }
 
 pkg_postinst() {
-       echo
-       einfo "You can use \`/etc/init.d/gimps start\` to start a GIMPS client in the"
-       einfo "background at boot. Have a look at /etc/conf.d/gimps and check some"
-       einfo "configuration options."
-       einfo
-       einfo "If you don't want to use the init script to start gimps, remember to"
-       einfo "pass it an additional command line parameter specifying where the data"
-       einfo "files are to be stored, e.g.:"
-       einfo "   ${I}/mprime -w/var/lib/gimps"
-       echo
+       readme.gentoo_print_elog
 }
 
 pkg_postrm() {