diff options
| author |   Horea Christian <horea.christ@yandex.com> | 2018-08-14 22:02:17 +0200 |
|---|---|---|
| committer | Horea Christian <horea.christ@yandex.com> | 2018-08-14 22:02:17 +0200 |
| commit | ec617588fdb360be14e1f375ba2c555ca36dd029 (patch) | |
| tree | bf12e654aebe779fc5501af0ef00e68b6acb9609 /README.md | |
| parent | sys-cluster/openmpi: bump 2.1.4 (diff) | |
| download | sci-ec617588fdb360be14e1f375ba2c555ca36dd029.tar.gz sci-ec617588fdb360be14e1f375ba2c555ca36dd029.tar.bz2 sci-ec617588fdb360be14e1f375ba2c555ca36dd029.zip | |
Formatting improvements and install instructions
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 33 |
1 files changed, 27 insertions, 6 deletions
@@ -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). |