commit: 07613be42ffecd4eec55d95681d5c63b04c59776 Author: Horea Christian <chr <AT> chymera <DOT> eu> AuthorDate: Tue Jan 5 07:11:49 2021 +0000 Commit: Horea Christian <horea.christ <AT> gmail <DOT> com> CommitDate: Tue Jan 5 07:29:55 2021 +0000 URL: https://gitweb.gentoo.org/proj/sci.git/commit/?id=07613be4
Readme.md: cleanup, style, formatting, grammar Signed-off-by: Horea Christian <chr <AT> chymera.eu> README.md | 103 ++++++++++++++++++++++++++++++++++---------------------------- 1 file changed, 57 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index d2bbf2fe9..4b9bffe66 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,7 @@ <tr> <td width="69%"> -**This is an official mirror of the Gentoo Science Projects [ebuild repository](https://wiki.gentoo.org/wiki/Ebuild_repository) which provides numerous scientific software packages.** - -The Gentoo [developer manual](https://devmanual.gentoo.org/) take precedence over any information here. +**This is an official mirror of the Gentoo Science [ebuild repository](https://wiki.gentoo.org/wiki/Ebuild_repository), containing numerous scientific software packages.** *See [Project:Science](https://wiki.gentoo.org/wiki/Project:Science) for more information on the project.* @@ -19,99 +17,112 @@ The Gentoo [developer manual](https://devmanual.gentoo.org/) take precedence ove ### Contents -1. [Installation and usage](#install) +1. [Installation](#install) - [Manual](#install-manual) - [Layman](#install-layman) -2. [Contributor guidelines](#guide) +2. [Usage](#usage) +3. [Contributing](#contributing) </td> </tr> </table> -## Install <a name="install"></a> +## Installation <a name="install"></a> -### Manual install <a name="install-manual"></a> +### 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 our overlay without the need for additional software, you first need to have **git(1)** installed: +To enable the overlay without the need for additional software, you first need to have `git` installed: -``` -emerge --ask --verbose dev-vcs/git +```console +emerge --ask --verbose dev-vcs/git ```` -Then you can add the custom entry for the science repository by downloading the [science.conf](metadata/science.conf) file +Then you need to add the science repository configuration by downloading the [science.conf](metadata/science.conf) file: -``` +```console wget https://gitweb.gentoo.org/proj/sci.git/plain/metadata/science.conf \ -O /etc/portage/repos.conf/science ``` -To start using the overlay you now only need to sync the overlay, via +### Manual Uninstall -``` -emaint sync --repo science +To uninstall the overlay, simply run: + +```console +rm /etc/portage/repos.conf/science +rm /var/db/repos/science -rf ``` -or the traditional +### Layman Install <a name="install-layman"></a> -``` -emerge --sync +You can also install the overlay via the [layman](https://wiki.gentoo.org/wiki/Layman) overlay manager. + +```console +emerge --ask --verbose app-portage/layman +layman --add science ``` -### Manual uninstall +### Layman Uninstall -To uninstall the overlay simply run: +To delete the overlay, run: -``` -rm /etc/portage/repos.conf/science -rm /var/db/repos/science -rf +```console +layman --delete science ``` -### Layman install <a name="install-layman"></a> +### Using Packages from `::science` -You can also install the overlay via the [layman](https://wiki.gentoo.org/wiki/Layman) overlay manager +To start using the overlay you now only need to get the newest files, via: +```console +emerge --sync science ``` -layman --add science + +To be able to install `::science` packages you need to make sure that you are accepting the `~${ARCH}` keyword for your respective architecture. This may already be the case globally on your system, and you can check whether this is the case by running: + +```console +grep "~$(portageq envvar ARCH)" /etc/portage/make.conf ``` -### Layman uninstall +If the above returns empty, you will need to instruct Portage to accept `~${ARCH}` packages. -To delete the overlay run +This can be done for `::science` specifically: -``` -layman --delete science +```console +mkdir -p /etc/portage/package.accept_keywords +printf '*/*::science ~%s' "$(portageq envvar ARCH)" >> /etc/portage/package.accept_keywords/science ``` -### Using packages from ::science +If the above fails with `mkdir: cannot create directory ‘/etc/portage/package.accept_keywords’: File exists` this means you are using a file and not a directory, and you can instead run: -To enable the packges from `::science` you need to make sure that you are accepting the `~${ARCH}` keywords for your respective arch. +```console +printf '*/*::science ~%s' "$(portageq envvar ARCH)" >> /etc/portage/package.accept_keywords +``` -Make sure that the `/etc/portage/package.accept_keywords/` folder exists and run +Alternatively, and *only if you know what you are doing*, you can accept `~${ARCH}` packages globally: +```console +printf 'ACCEPT_KEYWORDS="~%s"' "$(portageq envvar ARCH)" >> lala ``` -printf '*/*::science ~%s' "$(portageq envvar ARCH)" >> /etc/portage/package.accept_keywords/SCIENCE -``` -## Generic guidelines for contributors <a name="guide"></a> +The downside of this approach is potentially higher instability, the advantage is that often `::science` packages require `~${ARCH}` packages from `::gentoo` as well. + -If you fork, we will merge! -We are always going to welcome new contributors and love expanding our collection. +## Contributing <a name="contributing"></a> -For basic guidelines please see our [contributing guide](CONTRIBUTING.md). +*If you fork, we will merge!* +We welcome new contributors and are happy to include new packages. +For a brief introduction please see our [contributing guide](CONTRIBUTING.md). Further helpful resources are: -The [GURU Project](https://wiki.gentoo.org/wiki/Project:GURU) has created excellent documentation for potential contributors. -We highly advise you to give them a read along with other general Gentoo guidelines -- GURU guidelines - https://wiki.gentoo.org/wiki/Project:GURU#The_regulations +- Gentoo Developers Manual - https://devmanual.gentoo.org/ (taking precedence over any other information found here) - Contributing to Gentoo - https://wiki.gentoo.org/wiki/Contributing_to_Gentoo -- Gentoo Developers Manual - https://devmanual.gentoo.org/ -In addition to the above guidelines please make sure that if you submitting a new package, please add the Science Project as an additional maintainer to the package. -For an example, take a look at the metadata for the [Numba](dev-python/numba) package - [dev-python/numba/metadata.xml](dev-python/numba/metadata.xml) +Additionally, please make sure to add the Science Project as an additional maintainer to any new packages you submit. For an example, take a look at the metadata for the [Numba](dev-python/numba) package - [dev-python/numba/metadata.xml](dev-python/numba/metadata.xml) ## Support -You can ask for help on [Freenode IRC](https://www.gentoo.org/get-involved/irc-channels/) in [**#gentoo-science**](http://webchat.freenode.net/?channels=gentoo-science). +You can ask for help on [Freenode IRC](https://www.gentoo.org/get-involved/irc-channels/) in [**#gentoo-science**](http://webchat.freenode.net/?channels=gentoo-science). Alternatively you can report bugs on the [GitHub issues page](https://github.com/gentoo/sci/issues).
