Skip to content

Commit

Permalink
Trac #31909: Update distro prereq links in README
Browse files Browse the repository at this point in the history
In #29124 the text files describing prerequisite package
names for each distribution moved from `build/pkgs/*.txt`
to `build/pkgs/_prereq/distros/*.txt`.

This ticket updates links in the README accordingly.

URL: https://trac.sagemath.org/31909
Reported by: slelievre
Ticket author(s): Samuel Lelièvre
Reviewer(s): Matthias Koeppe
  • Loading branch information
Release Manager committed Jun 29, 2021
2 parents bee8f56 + bd9a33c commit 1d16268
Showing 1 changed file with 28 additions and 21 deletions.
49 changes: 28 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,11 @@
https://www.sagemath.org

The Sage Library is GPLv2+, and included packages have [compatible OSS
licenses](./COPYING.txt). [Over 400 people](https://www.sagemath.org/development-map.html)
have contributed code to Sage. In many cases, documentation for modules
and functions list the authors.
The Sage Library is GPLv2+, and included packages have
[compatible OSS licenses](./COPYING.txt).
[Over 400 people](https://www.sagemath.org/development-map.html)
have contributed code to Sage. In many cases, documentation
for modules and functions list the authors.

Getting Started
---------------
Expand All @@ -22,7 +23,7 @@ If you downloaded a [binary](https://www.sagemath.org/download.html)
Sage is ready to start -- just open a terminal in the directory where
you extracted the binary archive and type:

./sage
$ ./sage

(Note that the first run will take more time, as Sage needs to get itself ready.)

Expand Down Expand Up @@ -118,9 +119,9 @@ virtual appliance](https://wiki.sagemath.org/SageAppliance).
------------------------------

Make sure you have installed the most current version of Xcode
supported on your version of macOS. If you don't, go to
supported on your version of macOS. If you don't, either go to
https://developer.apple.com/, sign up, and download the free Xcode
package.
package, or get it from Apple's app store.

You also need to install the "command line tools": After installing
Xcode, run `xcode-select --install` from a terminal window; then click
Expand All @@ -131,7 +132,7 @@ and then "Install" the Command Line Tools.)

Optionally, you can consider installing Homebrew ("the missing package
manager for macOS") from https://brew.sh/, which can provide libraries
such gfortran, gmp, etc.
such as gfortran, gmp, etc.

Instructions to Build from Source
---------------------------------
Expand Down Expand Up @@ -173,11 +174,12 @@ Guide](https://doc.sagemath.org/html/en/installation).

- [Git] Alternatively, clone the Sage git repository:

$ git clone -c core.symlinks=true --branch master https://github.com/sagemath/sage.git
$ ORIG=https://github.com/sagemath/sage.git
$ git clone -c core.symlinks=true --branch master $ORIG

This will create the subdirectory `sage`. `cd sage/` and pick the branch you need
by doing `git checkout` - typically you want the latest development branch, thus do
`git checkout develop`.
This will create the subdirectory `sage`. `cd sage/` and pick
the branch you need by doing `git checkout` - typically you want
the latest development branch, thus do `git checkout develop`.

- [Windows] The Sage source tree contains symbolic links, and the
build will not work if Windows line endings rather than UNIX
Expand All @@ -186,8 +188,8 @@ Guide](https://doc.sagemath.org/html/en/installation).
Therefore it is crucial that you unpack the source tree from the
Cygwin (or WSL) `bash` using the Cygwin (or WSL) `tar` utility
and not using other Windows tools (including mingw). Likewise,
when using `git`, it is recommended (but not necessary) to use the Cygwin (or WSL)
version of `git`.
when using `git`, it is recommended (but not necessary) to use
the Cygwin (or WSL) version of `git`.

3. `cd` into the source/build directory:

Expand Down Expand Up @@ -224,11 +226,16 @@ Guide](https://doc.sagemath.org/html/en/installation).
avoid having to build Sage's own copy of Python 3.

We have collected lists of system packages that provide these build
prerequisites. See [build/pkgs/arch.txt](build/pkgs/arch.txt),
[cygwin.txt](build/pkgs/cygwin.txt),
[debian.txt](build/pkgs/debian.txt) (also for Ubuntu, Linux Mint,
etc.), [fedora.txt](build/pkgs/fedora.txt) (also for Red Hat,
CentOS), and [slackware.txt](build/pkgs/slackware.txt).
prerequisites. See, in the folder
[build/pkgs/_prereq/distros](build/pkgs/_prereq/distros),
the files
[arch.txt](build/pkgs/_prereq/distros/arch.txt),
[cygwin.txt](build/pkgs/_prereq/distros/cygwin.txt),
[debian.txt](build/pkgs/_prereq/distros/debian.txt)
(also for Ubuntu, Linux Mint, etc.),
[fedora.txt](build/pkgs/_prereq/distros/fedora.txt)
(also for Red Hat, CentOS), and
[slackware.txt](build/pkgs/_prereq/distros/slackware.txt).

7. Optional, but highly recommended: Make sure your system has an SSL
library and its development files installed.
Expand All @@ -245,7 +252,7 @@ Guide](https://doc.sagemath.org/html/en/installation).
9. Optionally, review the configuration options, which includes
many optional packages:

./configure --help
$ ./configure --help

10. Optional, but highly recommended: Set some environment variables to
customize the build.
Expand Down Expand Up @@ -470,7 +477,7 @@ do.

2. (**Obsolete, probably broken**) To make your own source tarball of Sage, type:

sage --sdist
$ sage --sdist

The result is placed in the directory `dist/`.

Expand Down

0 comments on commit 1d16268

Please sign in to comment.