From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id 12C70138359 for ; Sun, 27 Sep 2020 17:22:34 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 3C746E0788; Sun, 27 Sep 2020 17:22:33 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 0A938E0788 for ; Sun, 27 Sep 2020 17:22:32 +0000 (UTC) Received: from oystercatcher.gentoo.org (oystercatcher.gentoo.org [148.251.78.52]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 4794D335D8F for ; Sun, 27 Sep 2020 17:22:31 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id B051A36F for ; Sun, 27 Sep 2020 17:22:29 +0000 (UTC) From: "Aisha Tammy" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Aisha Tammy" Message-ID: <1601227325.0d9d7df9b0cda2bb8fd679493f70c269f51848af.epsilon-0@gentoo> Subject: [gentoo-commits] proj/sci:master commit in: / X-VCS-Repository: proj/sci X-VCS-Files: README.md X-VCS-Directories: / X-VCS-Committer: epsilon-0 X-VCS-Committer-Name: Aisha Tammy X-VCS-Revision: 0d9d7df9b0cda2bb8fd679493f70c269f51848af X-VCS-Branch: master Date: Sun, 27 Sep 2020 17:22:29 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply X-Archives-Salt: d848e267-2c16-4d06-a26d-b36d0e04116a X-Archives-Hash: 70f466b959c6b07c589d65fbf74f6606 commit: 0d9d7df9b0cda2bb8fd679493f70c269f51848af Author: A. Tammy users noreply github com> AuthorDate: Sun Sep 27 17:19:33 2020 +0000 Commit: Aisha Tammy aisha cc> CommitDate: Sun Sep 27 17:22:05 2020 +0000 URL: https://gitweb.gentoo.org/proj/sci.git/commit/?id=0d9d7df9 README expansion update the README to be more informative and user friendly Package-Manager: Portage-3.0.8, Repoman-3.0.1 Signed-off-by: Aisha Tammy aisha.cc> README.md | 111 ++++++++++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 93 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index f328e252f..ba5175935 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,114 @@ -# [Gentoo Science](https://wiki.gentoo.org/wiki/Project:Science/Overlay) Overlay +# The [Gentoo Science Project](https://wiki.gentoo.org/wiki/Project:Science) Repository [![Build Status](https://travis-ci.com/gentoo/sci.svg?branch=master)](https://travis-ci.com/gentoo/sci) -This is a Gentoo Linux [ebuild repository](https://wiki.gentoo.org/wiki/Ebuild_repository) which provides numerous scientific software packages. + + + + + +
-## Install +**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.** -As per the current [Portage specifications](https://dev.gentoo.org/~zmedico/portage/doc/man/portage.5.html), ebuild repositories (a.k.a. overlays) should be managed via file collections under `/etc/portage/repos.conf/`. -To enable our overlay without the need for additional software, simply run (as root): +The Gentoo [developer manual](https://devmanual.gentoo.org/) take precedence over any information here. + +*See [Project:Science](https://wiki.gentoo.org/wiki/Project:Science) for more information on the project.* + + + +### Contents + +1. [Installation and usage](#install) + - [Manual](#install-manual) + - [Layman](#install-layman) +2. [Contributor guidelies](#guide) + +
+ +## Install + +### Manual install + +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: ``` -wget https://gitweb.gentoo.org/proj/sci.git/plain/metadata/science.conf -O /etc/portage/repos.conf/science +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 + +``` +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 get the ebuilds, via `emerge --sync`. +To start using the overlay you now only need to sync the overlay, via -### BLAS and LAPACK +``` +emaint sync --repo science +``` -[The BLAS and LAPACK switching framework](https://wiki.gentoo.org/wiki/Blas-lapack-switch) -in ::gentoo has been implemented. The Science overlay will no longer -carry blas and lapack ebuilds. +or the traditional + +``` +emerge --sync +``` -### Uninstall +### Manual uninstall -To uninstall the overlay run (again, as root): +To uninstall the overlay simply run: ``` rm /etc/portage/repos.conf/science rm /var/db/repos/science -rf ``` -## Support +### Layman install -You can ask for help on [Freenode IRC](https://www.gentoo.org/get-involved/irc-channels/) in `#gentoo-science`. -Alternatively you can report bugs on the [GitHub issues page](https://github.com/gentoo/sci/issues). +You can also install the overlay via the [layman](https://wiki.gentoo.org/wiki/Layman) overlay manager -## Contribute +``` +layman --add science +``` -Please fork! We will merge! See [our contributing guide](https://github.com/gentoo/sci/blob/master/CONTRIBUTING.md). +### Layman uninstall + +To delete the overlay run + +``` +layman --delete science +``` + +### Using packages from ::science + +To enable the packges from `::science` you need to make sure that you are accepting the `~${ARCH}` keywords for your respective arch. + +Make sure that the `/etc/portage/package.accept_keywords/` folder exists and run + +``` +printf '*/*::science ~%s' "$(portageq envvar ARCH)" >> /etc/portage/package.accept_keywords/SCIENCE +``` + +## Generic guidelines for contributors + +If you fork, we will merge! +We are always going to welcome new contributors and love expanding our collection. + +For basic guidelines please see our [contributing guide](CONTRIBUTING.md). + + +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 +- 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) + +## 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). +Alternatively you can report bugs on the [GitHub issues page](https://github.com/gentoo/sci/issues).