Skip to content

Commit 2ebff5c

Browse files
committed
README.md: Update "quickest start"
Remove the instructions, instead using Gentoo Wiki links to provide instructions for installing the repository and generating metadata. This will be less error prone (and will stay up-to-date if there are any changes to the process.) Rename "quickest start" to the more boring title of "quick start" (since "quickest start" implies there's a slightly slower "quick start" hiding somewhere.) Additionally, replace instructions in "Loner's corner" with a Gentoo Wiki link. Change a few formatting quirks. Signed-off-by: hololeap <hololeap@protonmail.com>
1 parent 20bba73 commit 2ebff5c

File tree

1 file changed

+14
-44
lines changed

1 file changed

+14
-44
lines changed

README.rst

Lines changed: 14 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -13,38 +13,23 @@ Find us in ``#gentoo-haskell`` on `libera.chat`_!
1313

1414
.. _libera.chat: https://libera.chat
1515

16-
Quickest start
17-
==============
18-
19-
First, let's enable the Gentoo Haskell overlay using the eselect-repository method::
2016

21-
# Install eselect-repository if you don't already have it
22-
emerge app-eselect/eselect-repository
23-
# Fetch and output the list of overlays
24-
eselect repository list
25-
eselect repository enable haskell
17+
----
2618

27-
Finally, we need to unmask the overlay (this does not apply if your system
28-
is already running on the ~testing branch)::
29-
# Unmask ~testing versions for your arch:
30-
echo "*/*::haskell" >> /etc/portage/package.accept_keywords
19+
Quick start
20+
===========
3121

32-
And here is the trick to speed up metadata resolution a bit.
33-
If you happen to use ``eix-sync`` for rsyncs you might
34-
like the following ``/etc/eix-sync.conf``::
22+
Enable the ``haskell`` repository in the normal manner explained here::
3523

36-
*
37-
@egencache --jobs="$(($(nproc) + 1))" --repo=haskell --update --update-use-local-desc
24+
https://wiki.gentoo.org/wiki/Eselect/Repository
3825

39-
It basically means:
26+
Optionally, enable a sync hook to automatically generate metadata for you::
4027

41-
- sync overlays in layman list before the main tree sync
28+
https://wiki.gentoo.org/wiki//etc/portage/repo.postsync.d#Pkgcore_example
4229

43-
- generate metadata for haskell repo after main
44-
tree sync is done, using N+1 cores
4530

4631
Overlay Priority
47-
================
32+
----------------
4833

4934
Gentoo has a mechanism to define which ebuild is selected in the event
5035
a package has the same version number in two different
@@ -76,6 +61,8 @@ In the haskell section of
7661
The value in the haskell section needs to be higher than in the
7762
``gentoo.conf`` file - if it isn't, then modify one or both so it is.
7863

64+
----
65+
7966
Developer's corner
8067
==================
8168

@@ -91,24 +78,7 @@ Alternatively if you really don't want to share any ebuilds (want to keep
9178
outdated package versions, highly experimental things, publicly unavailable
9279
stuff, other reasons) that's also fine.
9380

94-
You can keep such ebuilds in your local overlay.
95-
96-
Here is a complete example of creating minimal overlay with a
97-
single haskell ebuild from hackage::
98-
99-
# create overlay and populate it (gentoo-generic):
100-
$ mkdir my-ovl
101-
$ cd my-ovl
102-
$ mkdir metadata
103-
$ echo 'masters = gentoo' > metadata/layout.conf
104-
# register an overlay in /etc/portage/repos.conf:
105-
$ echo '[my-ovl]' >> /etc/portage/repos.conf
106-
$ echo "location = $(pwd)" >> /etc/portage/repos.conf
107-
108-
# haskell-specific stuff
109-
$ hackport -p . update
110-
# DONE!
111-
112-
# adding an example ebuild
113-
$ hackport merge hichi
114-
$ emerge -av1 hichi
81+
You can keep such ebuilds in a local repository. See "`Creating an ebuild
82+
repository`_" for instructions on how to set one up.
83+
84+
.. _Creating an ebuild repository: https://wiki.gentoo.org/wiki/Creating_an_ebuild_repository

0 commit comments

Comments
 (0)