From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <gentoo-commits+bounces-1041813-garchives=archives.gentoo.org@lists.gentoo.org> 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 59639138334 for <garchives@archives.gentoo.org>; Tue, 14 Aug 2018 20:03:02 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 4C678E0883; Tue, 14 Aug 2018 20:03:00 +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 27CE4E0883 for <gentoo-commits@lists.gentoo.org>; Tue, 14 Aug 2018 20:02:59 +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 BF214335CA3 for <gentoo-commits@lists.gentoo.org>; Tue, 14 Aug 2018 20:02:58 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id CAEDC39E for <gentoo-commits@lists.gentoo.org>; Tue, 14 Aug 2018 20:02:56 +0000 (UTC) From: "Horea Christian" <horea.christ@gmail.com> To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Horea Christian" <horea.christ@gmail.com> Message-ID: <1534276937.ec617588fdb360be14e1f375ba2c555ca36dd029.chymera@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: chymera X-VCS-Committer-Name: Horea Christian X-VCS-Revision: ec617588fdb360be14e1f375ba2c555ca36dd029 X-VCS-Branch: master Date: Tue, 14 Aug 2018 20:02:56 +0000 (UTC) Precedence: bulk List-Post: <mailto:gentoo-commits@lists.gentoo.org> List-Help: <mailto:gentoo-commits+help@lists.gentoo.org> List-Unsubscribe: <mailto:gentoo-commits+unsubscribe@lists.gentoo.org> List-Subscribe: <mailto:gentoo-commits+subscribe@lists.gentoo.org> List-Id: Gentoo Linux mail <gentoo-commits.gentoo.org> X-BeenThere: gentoo-commits@lists.gentoo.org X-Archives-Salt: 52eeaa05-e9b6-456b-9168-eb0eff8cf81f X-Archives-Hash: b1a780891f4d31cc27e1f33f784bb94c commit: ec617588fdb360be14e1f375ba2c555ca36dd029 Author: Horea Christian <horea.christ <AT> yandex <DOT> com> AuthorDate: Tue Aug 14 20:02:17 2018 +0000 Commit: Horea Christian <horea.christ <AT> gmail <DOT> com> CommitDate: Tue Aug 14 20:02:17 2018 +0000 URL: https://gitweb.gentoo.org/proj/sci.git/commit/?id=ec617588 Formatting improvements and install instructions README.md | 33 +++++++++++++++++++++++++++------ 1 file changed, 27 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 700a326a3..cb25afaad 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,33 @@ -# Gentoo Science Overlay +# [Gentoo Science](https://wiki.gentoo.org/wiki/Project:Science/Overlay) Overlay [](https://travis-ci.org/gentoo/sci) -An overlay for Gentoo Linux, geared towards scientific packages. +This is a Gentoo Linux [ebuild repository](https://wiki.gentoo.org/wiki/Ebuild_repository) which provides numerous scientific software packages. -Homepage: [Science Project page](https://wiki.gentoo.org/wiki/Project:Science/Overlay) +## Install -Please fork! We will merge! See [our contributing guide](https://github.com/gentoo/sci/blob/master/CONTRIBUTING.md) document for more details. +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): -Ask for help on [Freenode IRC](https://www.gentoo.org/get-involved/irc-channels/) in #gentoo-science @ freenode. +``` +wget https://gitweb.gentoo.org/proj/sci.git/plain/metadata/science.conf -O /etc/portage/repos.conf/science +``` -Report bugs on the [GitHub issues page](https://github.com/gentoo/sci/issues). +To start using the overlay you now only need to get the ebuilds, via `emerge --sync`. + +### Uninstall + +To uninstall the overlay run (again, as root): + +``` +rm /etc/portage/repos.conf/science +rm -rf /var/lib/overlays/science +``` + +## Support + +You can ask for help on [Freenode IRC](https://www.gentoo.org/get-involved/irc-channels/) in `#gentoo-science`. +Alternatively you can report bugs bugs on the [GitHub issues page](https://github.com/gentoo/sci/issues). + +## Contribute + +Please fork! We will merge! See [our contributing guide](https://github.com/gentoo/sci/blob/master/CONTRIBUTING.md).