Skip to content

Commit

Permalink
chore: README update (#97)
Browse files Browse the repository at this point in the history
Update README links and text
  • Loading branch information
david-christiansen authored Oct 21, 2024
1 parent 532cd32 commit 9e9ddb1
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
# Lean Language Reference

The Lean Language Reference is intended as a comprehensive, precise description of Lean. It is first and foremost a reference work in which Lean users can look up detailed information, rather than a tutorial for new users.

This new reference has been rebuilt from the ground up in Verso. This means that all example code is type checked, the source code contains tests to ensure that it stays up-to-date with respect to changes in Lean, and we can add any features that we need to improve the documentation. Verso also makes it easy to integrate tightly with Lean, so we can show function docstrings directly, mechanically check descriptions of syntax against the actual parser, and insert cross-references automatically.


## Reading the Manual

The output of building the current state of the `main` branch can be read at <https://lean-reference-manual-draft.netlify.app/>.
The latest release of this reference manual can be read [here](https://lean-lang.org/doc/reference/latest/).

For developers:
* The output of building the current state of the `main` branch can be read [here](https://lean-reference-manual-review.netlify.app/).
* Each pull request in this repository causes two separate previews to be generated, one with extra information that's only useful to those actively working on the text, such as TODO notes and symbol coverage progress bars. These are posted by a bot to the PR after the first successful build.

## Building the Reference Manual
## Building the Reference Manual Locally

To read the manual, run the following command:
To build the manual, run the following command:

```
lake exe generate-manual --depth 2
Expand All @@ -18,3 +27,8 @@ python3 -m http.server 8880 --directory _out/html-multi &
```

Then open <http://localhost:8880> in your browser.

## Contributing

Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

0 comments on commit 9e9ddb1

Please sign in to comment.