Skip to content

Commit c7443b1

Browse files
author
Release Manager
committed
gh-36815: Add badges to README.md <!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes #1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> for those who want to play with Sage instantly, and also as a preparation for #36245. See this [REAME.md](https://github.com/kwankyu/sage/tree/p/add-binder- badge-to-readme). <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes #12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - #12345: short description why this is a dependency - #34567: ... --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: #36815 Reported by: Kwankyu Lee Reviewer(s): Matthias Köppe
2 parents 2ec492a + 07a6fbc commit c7443b1

File tree

1 file changed

+29
-20
lines changed

1 file changed

+29
-20
lines changed

README.md

Lines changed: 29 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,14 @@ Table of Contents
4437
Getting Started
4538
---------------
4639

40+
Those who are impatient may use prebuilt Sage available online from any of
41+
42+
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/sagemath/sage-binder-env/master
43+
) &nbsp; [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/sagemath/sage/tree/master
44+
) &nbsp; [![Open in GitHub Codespaces](https://img.shields.io/badge/Open_in_GitHub_Codespaces-black?logo=github)](https://codespaces.new/sagemath/sage/tree/master)
45+
46+
without local installation. Otherwise read on.
47+
4748
The [Sage Installation Guide](https://doc.sagemath.org/html/en/installation/index.html)
4849
provides a decision tree that guides you to the type of installation
4950
that will work best for you. This includes building from source,
@@ -81,7 +82,7 @@ The preferred way to run Sage on Windows is using the [Windows Subsystem for
8182
Linux](https://docs.microsoft.com/en-us/windows/wsl/faq), a.k.a. WSL, which allows
8283
you to install a standard Linux distribution such as Ubuntu within
8384
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.
85+
2GB might be not enough for building Sage from source.
8586
Then all instructions for installation in Linux apply.
8687

8788
As an alternative, you can also run Linux on Windows using Docker ([see
@@ -428,18 +429,18 @@ in the Installation Guide.
428429
or JupyterLab installation, as described in [section
429430
"Launching SageMath"](https://doc.sagemath.org/html/en/installation/launching.html)
430431
in the installation manual.
431-
432+
432433
Alternative Installation using PyPI
433434
---------------
434435

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

437438
$ python3 -m pip install sage_conf
438439
$ ls $(sage-config SAGE_SPKG_WHEELS)
439-
$ python3 -m pip install $(sage-config SAGE_SPKG_WHEELS)/*.whl
440+
$ python3 -m pip install $(sage-config SAGE_SPKG_WHEELS)/*.whl
440441
$ python3 -m pip install sagemath-standard
441442

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`.
443+
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`.
443444

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

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

0 commit comments

Comments
 (0)