Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A few updates to branch/tag information in INSTALL #3141

Merged
merged 3 commits into from
Feb 22, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 18 additions & 7 deletions M2/INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,25 @@ command, assuming you have installed "git" on your machine:
git clone https://github.com/Macaulay2/M2

A directory called M2, which you can move or rename, will be created, and this
INSTALL file is in the subdirectory "M2" of it. The "release" branches tend to
be more stable, and if you compile from one of those, you'll have the same
functionality as those who download our binary releases. So, after cloning,
you can switch to the branch containing version 1.6, for example, with the
following command:
INSTALL file is in the subdirectory "M2" of it. By default, the "master" branch
of the M2 repository will be checked out.

The "release" tags tend to be more stable, and if you compile from one of
those, you'll have the same functionality as those who download our binary
releases. So, after cloning, you can switch to the tag containing version 1.6,
for example, with the following command:

git checkout release-1.6

Instead of release-1.6 you should, of course, use the most recent one.

The following command shows the list of release branches:
The following command shows the list of release tags:

git tag | grep release

git branch -a | grep origin/release
However, if some time has passed since the most recent release and your system
has newer versions of some of Macaulay2's dependencies than were available at
the time of the release, you may have more success building the "master" branch.

The following commands, run from the top level of this source tree (the parent
of the directory this file is in) will download the latest changes to the
Expand All @@ -55,6 +61,11 @@ source code:
git submodule sync
git submodule update

To obtain the latest, but potentially unstable, changes to the Macaulay2 source
code, switch to the "development" branch:

git checkout development

---------
Libraries
---------
Expand Down