Skip to content

Commit b535fc0

Browse files
committed
Edit README again
1 parent 48d0b7f commit b535fc0

File tree

1 file changed

+33
-16
lines changed

1 file changed

+33
-16
lines changed

README.rst

Lines changed: 33 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,49 @@
1-
Binder computing environment using SageMath
2-
===========================================
1+
A Binder repo for SageMath computing environment
2+
================================================
3+
4+
This repository is a Binder repo based on `SageMath <http://sagemath.org>`_. To
5+
access a computing environment created by `Binder <http://mybinder.org>`_ using
6+
SageMath kernel, click on this badge
37

48
.. image:: https://mybinder.org/badge_logo.svg
59
:target: https://mybinder.org/v2/gh/kwankyu/sage-binder-env/master
610

7-
This repository provides a `Binder <http://mybinder.org>`_ repo based on
8-
`SageMath <http://sagemath.org>`_.
911

12+
An example Binder repo for SageMath
13+
-----------------------------------
14+
15+
Have a repository full of Jupyter notebooks using SageMath? It's easy to setup
16+
Binder to let anyone run them. Just fork this repo, put your notebooks in the
17+
`notebooks` directory. and modify this `README.rst` to your needs. In
18+
particular, you probably want to modify this line::
1019

11-
An example of binder repository for SageMath
12-
--------------------------------------------
20+
:target: https://mybinder.org/v2/gh/...
1321

14-
Have a repository full of Jupyter notebooks using SageMath? It's easy
15-
to setup Binder to let anyone run them. Just copy the short
16-
`Dockerfile <Dockerfile>`_ from this repository, and adapt it to your needs. You
17-
probably also want to insert the Binder badge in your `README.rst`.
22+
with `...` replaced with your forked repo. This makes the Binder badge use your
23+
repo to create the Jupyter server.
1824

1925

2026
Extending the sagemath Docker image
2127
-----------------------------------
2228

23-
The sample `Dockerfile` in this repository is based on the official sagemath
24-
Docker image. It includes Sage itself, and all the software packages typically
25-
included in a standard Sage installation, though not *everything* (in
26-
particular not optional Sage SPKGs, or other system software packages).
29+
The `Dockerfile` builds Sage with base Docker image::
30+
31+
FROM ghcr.io/sagemath/sage/sage-ubuntu-focal-standard-with-targets-optional:dev
32+
33+
which contains Sage built in the current *develop* branch.
2734

28-
So in order to install additional Sage SPKGs it is possible to include a line like::
35+
It includes Sage itself, and all the software packages typically
36+
included in a standard Sage installation, though not *everything*. In
37+
particular not optional Sage SPKGs, or other system software packages.
38+
39+
So in order to install additional Sage SPKGs, it is possible to include a line like::
2940

3041
RUN sage -i <spkg-name>
3142

32-
in the ``Dockerfile``.
43+
in the `Dockerfile`.
44+
45+
46+
Authors
47+
-------
48+
49+
Nicolas M. Thiéry, E. Madison Bray, and Kwankyu Lee

0 commit comments

Comments
 (0)