Skip to content

Commit 726c438

Browse files
author
Release Manager
committed
gh-36378: Add README.md Table of Contents and Links - Added Table of Contents for accessible navigation - Added hyperlink to official documentation website - Updated macOS Silicon Chip options in platform preparation section. URL: #36378 Reported by: Mark Zhang Reviewer(s): Matthias Köppe
2 parents f1ac6c1 + 99529d5 commit 726c438

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

README.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,33 @@
1414
1515
https://www.sagemath.org
1616

17+
[Sage Documentation](https://doc.sagemath.org/html/en/index.html)
18+
1719
The Sage Library is free software released under the
1820
GNU General Public Licence GPLv2+, and included packages
1921
have [compatible software licenses](./COPYING.txt).
2022
[Over 800 people](https://www.sagemath.org/development-map.html)
2123
have contributed code to Sage. In many cases, documentation
2224
for modules and functions list the authors.
2325

26+
Table of Contents
27+
-----------------
28+
29+
* [Getting Started](#getting-started)
30+
* [Supported Platforms](#supported-platforms)
31+
* [\[Windows\] Preparing the Platform Libraries](#windows-preparing-the-platform)
32+
* [\[macOS\] Preparing the Platform Libraries](#macos-preparing-the-platform)
33+
* [Instructions to Build from Source](#instructions-to-build-from-source)
34+
* [SageMath Docker Images](#sagemath-docker-images)
35+
* [Troubleshooting](#troubleshooting)
36+
* [Contributing to Sage](#contributing-to-sage)
37+
* [Directory Layout](#directory-layout)
38+
* [Build System](#build-system)
39+
* [Relocation](#relocation)
40+
* [Redistribution](#redistribution)
41+
* [Build System](#build-system)
42+
* [Changes to Included Software](#changes-to-included-software)
43+
2444
Getting Started
2545
---------------
2646

@@ -47,7 +67,7 @@ macOS, and Windows (using Windows Subsystem for Linux or
4767
virtualization).
4868

4969
Detailed information on supported platforms for a specific version of Sage
50-
can be found in the section "Availability and installation help" of the
70+
can be found in the section _Availability and installation help_ of the
5171
[release tour](https://wiki.sagemath.org/ReleaseTours) for this version.
5272

5373
We highly appreciate contributions to Sage that fix portability bugs
@@ -64,13 +84,13 @@ your Windows. Make sure you allocate WSL sufficient RAM; 5GB is known to work, w
6484
2GB might be not enough for building Sage from source.
6585
Then all instructions for installation in Linux apply.
6686

67-
As an alternative, you can also run Linux on Windows using Docker (see
68-
below) or other virtualization solutions.
87+
As an alternative, you can also run Linux on Windows using Docker ([see
88+
below](#sagemath-docker-images)) or other virtualization solutions.
6989

7090
[macOS] Preparing the Platform
7191
------------------------------
7292

73-
If your Mac uses the Apple Silicon (M1, arm64) architecture:
93+
If your Mac uses the Apple Silicon (M1, M2, arm64) architecture:
7494

7595
- If you set up your Mac by transfering files from an older Mac, make sure
7696
that the directory ``/usr/local`` does not contain an old copy of Homebrew
@@ -117,6 +137,7 @@ More details, providing a background for these instructions, can be found
117137
in the [section "Install from Source Code"](https://doc.sagemath.org/html/en/installation/source.html).
118138
in the Installation Guide.
119139

140+
120141
1. Decide on the source/build directory (`SAGE_ROOT`):
121142

122143
- On personal computers, any subdirectory of your :envvar:`HOME`

0 commit comments

Comments
 (0)