Skip to content
This repository was archived by the owner on Jul 24, 2024. It is now read-only.

Commit 3ac76ec

Browse files
committed
doc: Add a warning mentioning Lean 4 to the readme (#19243)
Also correct links to point to the lean3 webpages; this means that users clicking them end up on pages which also have scary banners telling them not to use Lean 3.
1 parent c8f3055 commit 3ac76ec

File tree

1 file changed

+20
-13
lines changed

1 file changed

+20
-13
lines changed

README.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,32 @@
1-
# Lean mathlib
1+
# Lean 3's mathlib
2+
3+
> [!WARNING]
4+
> Lean 3 and Mathlib 3 are no longer actively maintained.
5+
> It is strongly recommended that you use [mathlib4](https://github.com/leanprover-community/mathlib4) for Lean 4 instead.
26
37
![](https://github.com/leanprover-community/mathlib/workflows/continuous%20integration/badge.svg?branch=master)
48
[![Bors enabled](https://bors.tech/images/badge_small.svg)](https://app.bors.tech/repositories/24316)
59
[![project chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://leanprover.zulipchat.com)
610
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/leanprover-community/mathlib)
711

8-
[Mathlib](https://leanprover-community.github.io) is a user maintained library for the [Lean theorem prover](https://leanprover.github.io).
12+
[Mathlib](https://leanprover-community.github.io) is a user maintained library for the [Lean 3 theorem prover](https://github.com/leanprover-community/lean).
913
It contains both programming infrastructure and mathematics,
1014
as well as tactics that use the former and allow to develop the latter.
1115

1216
## Installation
1317

14-
You can find detailed instructions to install Lean, mathlib, and supporting tools on [our website](https://leanprover-community.github.io/get_started.html).
18+
You can find detailed instructions to install Lean 3, mathlib 3, and supporting tools on [our website](https://leanprover-community.github.io/lean3/get_started.html).
1519

1620
## Experimenting
1721

18-
Got everything installed? Why not start with the [tutorial project](https://leanprover-community.github.io/install/project.html)?
22+
Got everything installed? Why not start with the [tutorial project](https://leanprover-community.github.io/lean3/install/project.html)?
1923

20-
For more pointers, see [Learning Lean](https://leanprover-community.github.io/learn.html).
24+
For more pointers, see [Learning Lean](https://leanprover-community.github.io/lean3/learn.html).
2125

2226
## Documentation
2327

2428
Besides the installation guides above and [Lean's general
25-
documentation](https://leanprover.github.io/documentation/), the documentation
29+
documentation](https://leanprover.github.io/lean3/documentation/), the documentation
2630
of mathlib consists of:
2731

2832
- [The mathlib docs](https://leanprover-community.github.io/mathlib_docs): documentation [generated
@@ -33,10 +37,10 @@ of mathlib consists of:
3337
- [hole commands](https://leanprover-community.github.io/mathlib_docs/hole_commands.html), and
3438
- [attributes](https://leanprover-community.github.io/mathlib_docs/attributes.html).
3539
- A description of [currently covered theories](https://leanprover-community.github.io/theories.html),
36-
as well as an [overview](https://leanprover-community.github.io/mathlib-overview.html) for mathematicians.
40+
as well as an [overview](https://leanprover-community.github.io/lean3/mathlib-overview.html) for mathematicians.
3741
- A couple of [tutorial Lean files](docs/tutorial/)
38-
- Some [extra Lean documentation](https://leanprover-community.github.io/learn.html) not specific to mathlib (see "Miscellaneous topics")
39-
- Documentation for people who would like to [contribute to mathlib](https://leanprover-community.github.io/contribute/index.html)
42+
- Some [extra Lean documentation](https://leanprover-community.github.io/lean3/learn.html) not specific to mathlib (see "Miscellaneous topics")
43+
- Documentation for people who would like to [contribute to mathlib3](https://leanprover-community.github.io/lean3/contribute/index.html)
4044

4145
Much of the discussion surrounding mathlib occurs in a
4246
[Zulip chat room](https://leanprover.zulipchat.com/). Since this
@@ -49,8 +53,11 @@ welcomed.
4953

5054
## Contributing
5155

56+
> [!WARNING]
57+
> Contributions are no longer accepted to mathlib 3; contribute to mathlib 4 instead!
58+
5259
The complete documentation for contributing to ``mathlib`` is located
53-
[on the community guide contribute to mathlib](https://leanprover-community.github.io/contribute/index.html)
60+
[on the community guide contribute to mathlib](https://leanprover-community.github.io/lean3/contribute/index.html)
5461

5562
The process is different from other projects where one should not fork the repository.
5663
Instead write permission for non-master branches should be requested on [Zulip](https://leanprover.zulipchat.com)
@@ -60,9 +67,9 @@ by introducing yourself, providing your GitHub handle and what contribution you
6067

6168
Mathlib has the following guidelines and conventions that must be followed
6269

63-
- The [style guide](https://leanprover-community.github.io/contribute/style.html)
64-
- A guide on the [naming convention](https://leanprover-community.github.io/contribute/naming.html)
65-
- The [documentation style](https://leanprover-community.github.io/contribute/doc.html)
70+
- The [style guide](https://leanprover-community.github.io/lean3/contribute/style.html)
71+
- A guide on the [naming convention](https://leanprover-community.github.io/lean3/contribute/naming.html)
72+
- The [documentation style](https://leanprover-community.github.io/lean3/contribute/doc.html)
6673
- The [commit naming conventions](https://github.com/leanprover-community/lean/blob/master/doc/commit_convention.md)
6774

6875
Note: the title of a PR should follow the commit naming convention.

0 commit comments

Comments
 (0)