Skip to content

Commit

Permalink
Make README.md slim
Browse files Browse the repository at this point in the history
  • Loading branch information
kwankyu committed Sep 20, 2024
1 parent a880b3f commit ccd9dca
Show file tree
Hide file tree
Showing 9 changed files with 1,137 additions and 1,092 deletions.
2 changes: 1 addition & 1 deletion .ci/retrofit-worktree.sh
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ git worktree add --detach $WORKTREE_NAME
rm -rf $WORKTREE_DIRECTORY/.git && mv $WORKTREE_NAME/.git $WORKTREE_DIRECTORY/
rm -rf $WORKTREE_NAME && ln -s $WORKTREE_DIRECTORY $WORKTREE_NAME
if [ ! -f $WORKTREE_NAME/.gitignore ]; then cp .gitignore $WORKTREE_NAME/; fi
(cd $WORKTREE_NAME && git add -A && git commit --quiet --allow-empty -m "old" -a && git tag -f old && git checkout new && git status)
(cd $WORKTREE_NAME && git add -A && git commit --quiet --allow-empty -m "old" -a && git tag -f old && git checkout -f new && git clean -fd && git status)
760 changes: 189 additions & 571 deletions README.md

Large diffs are not rendered by default.

54 changes: 39 additions & 15 deletions src/doc/en/installation/binary.rst
Original file line number Diff line number Diff line change
@@ -1,33 +1,57 @@
.. _sec-installation-from-binaries:

Install from Pre-Built Binaries
===============================
Install from Prebuilt Binaries
==============================

.. _sec-installation-linux:

Linux
-----

SageMath used to provide pre-built binaries for several Linux flavors.
This has been discontinued, as most major Linux distributions have
up-to-date distribution packages providing SageMath.
See :ref:`sec-GNU-Linux` for information.
Sage is available from various distributions and can be installed
by package managers.

As of Sage 10.2, we can recommend the following distributions, which
provide well-maintained and up-to-date Sage packages:
`Arch Linux <https://archlinux.org/>`_
and `Void Linux <https://voidlinux.org/>`_.

Gentoo users might want to give a try to
`sage-on-gentoo <https://github.com/cschwan/sage-on-gentoo>`_.

**Do not install a version of Sage older than 9.5.**
If you are on an older version of your distribution and a recent
version of Sage is only available on a newer version of the
distribution, consider upgrading your distribution.

See `the _sagemath dummy package <../reference/spkg/_sagemath.html>`_
for the names of packages that provide a standard installation of
Sage, including documentation and Jupyter. See also `repology.org: sagemath
<https://repology.org/project/sagemath/versions>`_ for information
about versions of Sage packages in various distributions.

The `GitHub wiki page Distribution <https://github.com/sagemath/sage/wiki/Distribution>`_
collects information regarding packaging and distribution of Sage.

.. _sec-installation-mac:

macOS
-----

macOS binaries are available `from the 3-manifolds project
<https://github.com/3-manifolds/Sage_macOS/releases/>`_. These
have been signed and notarized, eliminating various errors caused by
Apple's gatekeeper antimalware protections.
macOS binaries are available from `the 3-manifolds project <https://github.com/3-manifolds/Sage_macOS/releases/>`_.
It is a signed and notarized app, which works for macOS 10.12 and newer. It is
completely self-contained and provides the standard Sage distribution together
with many optional packages. Additional optional Python packages can be
installed with the ``%pip`` magic command and will go into your ``~/.sage``
directory.

SageMath used to provide pre-built binaries for macOS on its mirrors.
Sage used to provide prebuilt binaries for macOS on its mirrors.
This has been discontinued, and the old binaries that are still available
there are no longer supported.

Windows
-------

Microsoft Windows
-----------------

SageMath used to provide pre-built binaries for Windows based on Cygwin.
Sage used to provide prebuilt binaries for Windows based on Cygwin.
This has been discontinued, and the old binaries that can be found
are no longer supported. Use Windows Subsystem for Linux instead.
17 changes: 9 additions & 8 deletions src/doc/en/installation/conda.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
Install from conda-forge
========================

SageMath can be installed on Linux and macOS via Conda from the
`conda-forge <https://conda-forge.org>`_ conda channel.
Sage can be installed via Conda from the `conda-forge
<https://conda-forge.org>`_ conda channel.

Both the ``x86_64`` (Intel) architecture and the ``arm64``/``aarch64``
architectures (including Apple Silicon, M1, M2, M3, M4) are supported.
Expand Down Expand Up @@ -33,10 +33,11 @@ which uses a faster dependency solver than ``conda``.

.. _sec-installation-conda-binary:

Installing all of SageMath from conda (not for development)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Installing all of Sage from conda
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create a new conda environment containing SageMath, either with ``mamba`` or ``conda``:
This is a quick way to install Sage for non-developer users. Create a new conda
environment containing Sage, either with ``mamba`` or ``conda``:

.. tab:: mamba

Expand All @@ -55,7 +56,7 @@ where ``X`` is version of Python, e.g. ``3.9``.
To use Sage from there,

* Enter the new environment: ``conda activate sage``
* Start SageMath: ``sage``
* Start Sage: ``sage``

If there are any installation failures, please report them to
the conda-forge maintainers by opening a `GitHub Issue for
Expand All @@ -67,7 +68,7 @@ conda-forge/sage-feedstock <https://github.com/conda-forge/sage-feedstock/issues
Using conda to provide system packages for the Sage distribution
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If Conda is installed (check by typing ``conda info``), one can install SageMath
If Conda is installed (check by typing ``conda info``), one can install Sage
from source as follows:

- Create a new conda environment including all standard packages
Expand All @@ -84,7 +85,7 @@ from source as follows:
A different Python version can be selected by replacing ``3.11`` by ``3.9``
or ``3.10`` in these commands.

- Then the SageMath distribution will be built using the compilers provided by Conda
- Then the Sage distribution will be built using the compilers provided by Conda
and using many packages installed by Conda::

$ ./bootstrap
Expand Down
Loading

0 comments on commit ccd9dca

Please sign in to comment.