summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.rst33
1 files changed, 27 insertions, 6 deletions
diff --git a/README.rst b/README.rst
index 40f446a..2421166 100644
--- a/README.rst
+++ b/README.rst
@@ -2,17 +2,24 @@ Guix science packages
2===================== 2=====================
3 3
4.. image:: https://github.com/guix-science/guix-science/workflows/build/badge.svg 4.. image:: https://github.com/guix-science/guix-science/workflows/build/badge.svg
5 :target: https://github.com/guix-science/guix-science/actions
5 6
6This GNU Guix_ channel provides recent versions of scientific software, which 7This GNU Guix_ channel provides recent versions of scientific software, which
7cannot be included upstream. Currently the following software is packaged: 8cannot be included upstream. Currently the following software is packaged:
8 9
10- JASP_ (``jasp``)
9- Jupyter Notebook (``python-notebook``) 11- Jupyter Notebook (``python-notebook``)
10- JupyterLab (``python-jupyterlab``) 12- JupyterLab_ (``python-jupyterlab``)
11- RStudio Desktop (``rstudio``) 13- `RStudio Desktop`_ (``rstudio``)
12- RStudio Web (``rstudio-server``) 14- RStudio Server (``rstudio-server``)
13 15
14See `Using a Custom Guix Channel`_ for instructions how to add it to your 16.. _JASP: https://jasp-stats.org/
15installation or simply add the following snippet to your ``channels.scm``: 17.. _JupyterLab: https://jupyterlab.readthedocs.io/
18.. _RStudio Desktop: https://rstudio.com/products/rstudio/
19
20See `Specifying Additional Channels`_ in the Guix manual for instructions how
21to add it to your installation or simply add the following snippet to your
22``channels.scm``:
16 23
17.. code:: scheme 24.. code:: scheme
18 25
@@ -26,6 +33,20 @@ installation or simply add the following snippet to your ``channels.scm``:
26 "CA4F 8CF4 37D7 478F DA05 5FD4 4213 7701 1A37 8446")))) 33 "CA4F 8CF4 37D7 478F DA05 5FD4 4213 7701 1A37 8446"))))
27 34
28.. _Guix: https://guix.gnu.org/ 35.. _Guix: https://guix.gnu.org/
29.. _Using a Custom Guix Channel: https://guix.gnu.org/manual/en/guix.html#Using-a-Custom-Guix-Channel 36.. _Specifying Additional Channels: https://guix.gnu.org/manual/en/guix.html#Specifying-Additional-Channels
37
38Contributing
39------------
40
41We accept software fulfilling the following criteria:
42
43- `Free and open source`_. Use guix-science-nonfree_ otherwise.
44- Related to scientific research or teaching.
45- Not upstreamable to Guix proper per their rules. For example: Some parts
46 cannot be built from source without major efforts, excessive vendoring,
47 prebuilt JavaScript, … Dependencies are exempt from this rule, although we
48 prefer to have them upstreamed if possible.
30 49
50.. _Free and open source: https://opensource.org/osd
51.. _guix-science-nonfree: https://github.com/guix-science/guix-science-nonfree
31 52