Skip to content

Commit 95dcb39

Browse files
committed
Add binder badge to README.md
1 parent 2a9a426 commit 95dcb39

File tree

1 file changed

+27
-20
lines changed

1 file changed

+27
-20
lines changed

README.md

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,20 @@
1+
<div>
12
<a href="https://sagemath.org">
23
<picture>
34
<source media="(prefers-color-scheme: dark)" srcset="src/doc/common/static/logo_sagemath_white.svg">
45
<img src="src/doc/common/static/logo_sagemath_black.svg" height="60" align="left">
56
</picture>
67
</a>
8+
<em>"Creating a Viable Open Source Alternative to
9+
Magma, Maple, Mathematica, and MATLAB"</em>
10+
</div>
711

8-
# Sage: Open Source Mathematical Software
12+
#
913

10-
> "Creating a Viable Open Source Alternative to
11-
> Magma, Maple, Mathematica, and MATLAB"
12-
13-
> Copyright (C) 2005-2023 The Sage Development Team
14-
15-
https://www.sagemath.org
16-
17-
[Sage Documentation](https://doc.sagemath.org/html/en/index.html)
18-
19-
The Sage Library is free software released under the
20-
GNU General Public Licence GPLv2+, and included packages
21-
have [compatible software licenses](./COPYING.txt).
22-
[Over 800 people](https://www.sagemath.org/development-map.html)
23-
have contributed code to Sage. In many cases, documentation
24-
for modules and functions list the authors.
14+
Sage is open source mathematical software released under the GNU General Public
15+
Licence GPLv2+, and includes packages that have [compatible software licenses](./COPYING.txt).
16+
[People all around the globe](https://www.sagemath.org/development-map.html) have contributed to the
17+
development of Sage. [Full documentation](https://doc.sagemath.org/html/en/index.html) is available online.
2518

2619
Table of Contents
2720
-----------------
@@ -44,6 +37,12 @@ Table of Contents
4437
Getting Started
4538
---------------
4639

40+
Those who are impatient may use the Binder badge
41+
42+
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/sagemath/sage-binder-env/master)
43+
44+
for an instant computing environment with Sage. Otherwise read on.
45+
4746
The [Sage Installation Guide](https://doc.sagemath.org/html/en/installation/index.html)
4847
provides a decision tree that guides you to the type of installation
4948
that will work best for you. This includes building from source,
@@ -81,7 +80,7 @@ The preferred way to run Sage on Windows is using the [Windows Subsystem for
8180
Linux](https://docs.microsoft.com/en-us/windows/wsl/faq), a.k.a. WSL, which allows
8281
you to install a standard Linux distribution such as Ubuntu within
8382
your Windows. Make sure you allocate WSL sufficient RAM; 5GB is known to work, while
84-
2GB might be not enough for building Sage from source.
83+
2GB might be not enough for building Sage from source.
8584
Then all instructions for installation in Linux apply.
8685

8786
As an alternative, you can also run Linux on Windows using Docker ([see
@@ -428,18 +427,18 @@ in the Installation Guide.
428427
or JupyterLab installation, as described in [section
429428
"Launching SageMath"](https://doc.sagemath.org/html/en/installation/launching.html)
430429
in the installation manual.
431-
430+
432431
Alternative Installation using PyPI
433432
---------------
434433

435434
For installation of `sage` in python using `pip` you need to install `sagemath-standard`. First, activate your python virtual environment and follow these steps:
436435

437436
$ python3 -m pip install sage_conf
438437
$ ls $(sage-config SAGE_SPKG_WHEELS)
439-
$ python3 -m pip install $(sage-config SAGE_SPKG_WHEELS)/*.whl
438+
$ python3 -m pip install $(sage-config SAGE_SPKG_WHEELS)/*.whl
440439
$ python3 -m pip install sagemath-standard
441440

442-
You need to install `sage_conf`, a wheelhouse of various python packages. You can list the wheels using `ls $(sage-config SAGE_SPKG_WHEELS)`. After manual installation of these wheels, you can install the sage library, `sagemath-standard`.
441+
You need to install `sage_conf`, a wheelhouse of various python packages. You can list the wheels using `ls $(sage-config SAGE_SPKG_WHEELS)`. After manual installation of these wheels, you can install the sage library, `sagemath-standard`.
443442

444443
**NOTE:** You can find `sage` and `sagemath` pip packages but with these packages, you will encounter `ModuleNotFoundError`.
445444

@@ -647,3 +646,11 @@ Sources are in unmodified (as far as possible) tarballs in the
647646
information, patches, and build scripts are in the accompanying
648647
`build/pkgs/<packagename>` directory. This directory is
649648
part of the Sage git repository.
649+
650+
<p align="center">
651+
Copyright (C) 2005-2023 The Sage Development Team
652+
</p>
653+
<p align="center">
654+
https://www.sagemath.org
655+
</p>
656+

0 commit comments

Comments
 (0)