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

[Merged by Bors] - doc: merge mathlib3 and mathlib4 READMEs #6160

Closed
wants to merge 3 commits into from

Conversation

j-loreaux
Copy link
Collaborator

This tries to merge the READMEs for mathlib3 and mathlib4 in a sensible way. Some irrelevant material about leanproject was removed, as well as a few mathlib3-specific items. Some of these should be replaced by mathlib4 counterparts in the future.

A section has been added about transitioning from Lean 3 to Lean 4 linking to the survival guide and running mathport on a project depending on mathlib.


some things that were deleted but need replacing in the future:

from the documentation section:

In addition to the pages generated for each file in the library, the docs also include pages on:

from the guidelines section:

Open in Gitpod

README.md Outdated
Comment on lines 42 to 44
```shell
find Mathlib -name "*.lean" | env LC_ALL=C sort | sed 's/\.lean//;s,/,.,g;s/^/import /' > Mathlib.lean
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This command should be added to the contributing guidelines, I'd say we should keep it their (in the "contributing" section) for now.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point, I just added that entire bulleted list back under Contributing

@ADedecker
Copy link
Member

Thanks!

bors d+

@bors
Copy link

bors bot commented Jul 26, 2023

✌️ j-loreaux can now approve this pull request. To approve and merge a pull request, simply reply with bors r+. More detailed instructions are available here.

@j-loreaux
Copy link
Collaborator Author

bors merge

@github-actions github-actions bot added the ready-to-merge This PR has been sent to bors. label Jul 26, 2023
@j-loreaux
Copy link
Collaborator Author

trying again?

bors merge

bors bot pushed a commit that referenced this pull request Jul 26, 2023
This tries to merge the `README`s for mathlib3 and mathlib4 in a sensible way. Some irrelevant material about `leanproject` was removed, as well as a few mathlib3-specific items. Some of these should be replaced by mathlib4 counterparts in the future.

A section has been added about transitioning from Lean 3 to Lean 4 linking to the survival guide and running mathport on a project depending on mathlib.
@bors
Copy link

bors bot commented Jul 26, 2023

Pull request successfully merged into master.

Build succeeded!

The publicly hosted instance of bors-ng is deprecated and will go away soon.

If you want to self-host your own instance, instructions are here.
For more help, visit the forum.

If you want to switch to GitHub's built-in merge queue, visit their help page.

@bors bors bot changed the title doc: merge mathlib3 and mathlib4 READMEs [Merged by Bors] - doc: merge mathlib3 and mathlib4 READMEs Jul 26, 2023
@bors bors bot closed this Jul 26, 2023
@bors bors bot deleted the j-loreaux/migrate-readme branch July 26, 2023 23:03
semorrison pushed a commit that referenced this pull request Aug 14, 2023
This tries to merge the `README`s for mathlib3 and mathlib4 in a sensible way. Some irrelevant material about `leanproject` was removed, as well as a few mathlib3-specific items. Some of these should be replaced by mathlib4 counterparts in the future.

A section has been added about transitioning from Lean 3 to Lean 4 linking to the survival guide and running mathport on a project depending on mathlib.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
delegated ready-to-merge This PR has been sent to bors.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants