aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHorea Christian <chr@chymera.eu>2022-07-28 10:26:56 -0400
committerHorea Christian <chr@chymera.eu>2022-07-28 10:26:56 -0400
commitf9521dca269f92a6c5b06d6606213d8c8ef07ecc (patch)
tree4f0134e066fdfd6f282339040856fabbc09c0f39
parentdev-vcs/dandi-cli: version bump and versioneer dep removal (diff)
downloadsci-f9521dca269f92a6c5b06d6606213d8c8ef07ecc.tar.gz
sci-f9521dca269f92a6c5b06d6606213d8c8ef07ecc.tar.bz2
sci-f9521dca269f92a6c5b06d6606213d8c8ef07ecc.zip
README.md: expanded instructions, standardized formulation
Signed-off-by: Horea Christian <chr@chymera.eu>
-rw-r--r--README.md24
1 files changed, 17 insertions, 7 deletions
diff --git a/README.md b/README.md
index 3904770a0..a6c202ca2 100644
--- a/README.md
+++ b/README.md
@@ -28,25 +28,35 @@
## Installation <a name="install"></a>
-### Eselect-repository install <a name="install-eselect"></a>
+### Eselect-repository Install <a name="install-eselect"></a>
+
+The overlay can be enabled via `repository` extension of the Gentoo `eselect` utility.
+
+```console
+emerge --noreplace eselect-repository
+eselect repository enable science
+```
+
+### Eselect-repository Uninstall
+
+To disable and remove the overlay, run:
-The easiest way to enable the overlay is to:
```console
-emerge --noreplace eselect-repository && eselect repository enable science && emerge --sync
+eselect repository disable science
+eselect repository remove science
```
-and emerge the package as usual.
### Manual Install <a name="install-manual"></a>
As per the current [Portage specifications](https://dev.gentoo.org/~zmedico/portage/doc/man/portage.5.html), ebuild repositories (a.k.a. overlays) can be managed via file collections under `/etc/portage/repos.conf/`, via the new [plug-in sync system](https://wiki.gentoo.org/wiki/Project:Portage/Sync).
-To enable the overlay without the need for additional software, you first need to have `git` installed:
+To enable the overlay without the need for dedicated repository software, you need to have `git` installed:
```console
emerge --ask --verbose dev-vcs/git
````
-Then you need to add the science repository configuration by downloading the [science.conf](metadata/science.conf) file:
+Then you can simply download the science repository configuration file, [science.conf](metadata/science.conf):
```console
wget https://gitweb.gentoo.org/proj/sci.git/plain/metadata/science.conf \
@@ -55,7 +65,7 @@ wget https://gitweb.gentoo.org/proj/sci.git/plain/metadata/science.conf \
### Manual Uninstall
-To uninstall the overlay, simply run:
+To disable and remove the overlay, run:
```console
rm /etc/portage/repos.conf/science