Mathematics in Lean
This tutorial depends on Lean 4, VS Code, and Mathlib. You can find the textbook both online and in this repository in html format or as a pdf document. The book is designed to be read as you work through examples and exercises, using a copy of this repository on your computer. Alternatively, you can use Gitpod to run Lean and VS Code in the cloud.
This version of Mathematics in Lean is designed for Lean 4 and Mathlib. For the Lean 3 version, see github.com/leanprover-community/mathematics_in_lean3.
To use this repository on your computer
Do the following:
Install Lean 4 and VS Code following these instructions.
In a terminal, navigate to the folder where you want to put a copy of the repository, and type
git clone git@github.com:leanprover-community/mathematics_in_lean.gitto fetch it from github.Navigate to
mathematics_in_lean, and executelake exe cache getto fetch a compiled version of the library,Mathlib.Type
code .to open the folder inVS Code. Alternatively, you can runVS Codeand chooseOpen Folderfrom theFilemenu. Be sure to open the foldermathematics_in_lean, not any other folder.
You can open the book in a side panel in VS Code as follows:
Type
ctrl-shift-P.Type
Lean 4: Open Documentation Viewin the bar that appears, and then press return. (You can press return to select it as soon as it is highlighted in the menu.)In the window that opens, click on
Open documentation of current project.
Each section in the book has an associated Lean file
with examples and exercises.
You can find them in the folder src, organized by chapter.
We recommend making a copy of that folder,
naming it something like my_files.
That way you can experiment with the files as you go
while leaving the originals intact.
If you have an HTML previewer installed as an extension, you can open html/index.html
and read the book in VS Code while you work on the exercises.
You can update to a newer version of this repository
by typing git pull followed by lake exe cache get
inside the mathematics_in_lean folder.
This will update the src folder, but will not change my_files.
To use this repository with Gitpod
If you have a Gitpod account or are willing to sign up for one,
just point your browser to https://gitpod.io/#/https://github.com/leanprover-community/mathematics_in_lean.
This creates a virtual machine in the cloud,
and installs Lean and mathlib.
It then presents you with a VS Code window, running in a virtual
copy of the repository.
You can then make a copy of the src directory, and so on,
following the instructions above.
Gitpod gives you 50 free hours every month.
When you are done working, choose Stop workspace from the menu on the left.
The workspace should also stop automatically
30 minutes after the last interaction or 3 minutes after closing the tab.
To restart a previous workspace, go to https://gitpod.io/workspaces/. If you change the filter from Active to All, you will see all your recent workspaces. You can pin a workspace to keep it on the list of active ones.
Contributing
PRs and issues should be opened at the upstream source repository.