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

make get_started point to the quickstart page #453

Open
wants to merge 1 commit into
base: lean4
Choose a base branch
from

Conversation

j-loreaux
Copy link
Contributor

This updates the "Get started with Lean" page so that it points to the quickstart guide first. We also remove the "basic" versions of the Mac OS and Debian install guides, but we leave in place the existing "detailed" versions for all platforms.

@@ -1,16 +1,24 @@
# Get started with Lean

Choose a reason for hiding this comment

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

I think (some) research mathematicians won't understand the difference between Lean and Mathlib. Maybe this can say: "Get started with Lean and Mathlib" (so they know it's a two-step process?)

@@ -1,16 +1,24 @@
# Get started with Lean

We have installation instructions for the following operating systems:
For users wishing to get started quickly and easily, the [quickstart guide](https://lean-lang.org/lean4/doc/quickstart.html) should walk you through the installation procedure if using the Visual Studio Code editor is acceptable.

Choose a reason for hiding this comment

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

Can these be explicitly marked as "Step 1: Install VSCode and Lean" (is it possible to make the "lean-lang.org" link pop up in another window, so this window isn't lost -- since they'll need to return to it to know how to make a Mathlib project), and "Step 2: Create a Project Using Mathlib", followed by the stated instructions?

@riccardobrasca
Copy link
Member

We should state clearly that someone who wants to use mathlib should stop after the step "install Lean version manager". The guide stops there in the sense that it doesn't say to go on with "set up Lean 4 project", but a mathematician who wants to start a project will probably continue thinking it is the right way. Also, I am not 100% sure we want to show the Lean documentation to mathematicians, I think what the step does is the same as clicking on Version management -> install elan.

@riccardobrasca
Copy link
Member

What I mean is that maybe it is better to write our own guide, similar to what I did here but adding the first two steps (installing the extension as in the quickstart page and then installing elan using the menu).

@riccardobrasca
Copy link
Member

Hmm, one also need git, curl and stuff like that, that are indeed installed following the guide but not via the menu I think.

@Kha
Copy link

Kha commented Mar 26, 2024

@j-loreaux @riccardobrasca Could you please make explicit why you do not want to follow the complete guide?

@riccardobrasca
Copy link
Member

@j-loreaux @riccardobrasca Could you please make explicit why you do not want to follow the complete guide?

I've nothing against the complete guide, but at some point a mathematician will probably want mathlib (newcomers don't know Lean and mathlib are separate entities), and I am not sure what is the best way of explaining this.

@Kha
Copy link

Kha commented Mar 27, 2024

The setup guide talks about Mathlib so if you think the wording should be improved, please open an issue at leanprover/vscode-lean4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants