Explain color/symbol code.

finite-set-exercises
Joshua Potter 2023-05-10 15:30:35 -06:00
parent acd8b3edff
commit 6b389f9170
3 changed files with 17 additions and 6 deletions

View File

@ -1,7 +1,7 @@
# bookshelf # bookshelf
A collection on the study of the books listed below. I aim to use [Lean](https://leanprover.github.io/) A study of the books listed below. Most proofs are conducted in LaTeX. Where
when possible and fallback to LaTeX when not. feasible, theorems are also formally proven in [Lean](https://leanprover.github.io/).
- [ ] Apostol, Tom M. Calculus, Vol. 1: One-Variable Calculus, with an Introduction to Linear Algebra. 2nd ed. Vol. 1. 2 vols. Wiley, 1991. - [ ] Apostol, Tom M. Calculus, Vol. 1: One-Variable Calculus, with an Introduction to Linear Algebra. 2nd ed. Vol. 1. 2 vols. Wiley, 1991.
- [x] Avigad, Jeremy. Theorem Proving in Lean, n.d. - [x] Avigad, Jeremy. Theorem Proving in Lean, n.d.
@ -15,7 +15,7 @@ when possible and fallback to LaTeX when not.
## Documentation ## Documentation
To generate Lean documentation, we use [bookshelf-docgen](https://github.com/jrpotter/bookshelf-docgen). To generate documentation, we use [bookshelf-docgen](https://github.com/jrpotter/bookshelf-docgen).
Refer to this project on prerequisites and then run the following to build and Refer to this project on prerequisites and then run the following to build and
serve files locally: serve files locally:
@ -27,3 +27,14 @@ serve files locally:
This assumes you have `python3` available in your `$PATH`. To change how the This assumes you have `python3` available in your `$PATH`. To change how the
server behaves, refer to the `.env` file located in the root directory of this server behaves, refer to the `.env` file located in the root directory of this
project. project.
A color/symbol code is used on generated PDF headers to indicate their status:
* Teal coloring (with a checkmark) indicates the corresponding proof is
complete. That is, the proof has been written in TeX and also formally
verified in Lean.
* Magenta coloring (with a spinner) indicates the corresponding proof is in
progress. That is, a proof in both TeX and Lean have not yet been finished,
but is actively being worked on.
* Red coloring (with a warning) indicates the formal Lean proof has not yet been
started. It may or may not also indicate the TeX proof has been written.

View File

@ -16,9 +16,9 @@
{"git": {"git":
{"url": "https://github.com/jrpotter/bookshelf-docgen.git", {"url": "https://github.com/jrpotter/bookshelf-docgen.git",
"subDir?": null, "subDir?": null,
"rev": "93aa96a2b6318d78cc505e45f6538d507ce0834c", "rev": "291f71e6c520751d52832c95f47cbc059c77bfa7",
"name": "doc-gen4", "name": "doc-gen4",
"inputRev?": "93aa96a2b6318d78cc505e45f6538d507ce0834c"}}, "inputRev?": "291f71e6c520751d52832c95f47cbc059c77bfa7"}},
{"git": {"git":
{"url": "https://github.com/mhuisi/lean4-cli", {"url": "https://github.com/mhuisi/lean4-cli",
"subDir?": null, "subDir?": null,

View File

@ -12,7 +12,7 @@ require std4 from git
"6006307d2ceb8743fea7e00ba0036af8654d0347" "6006307d2ceb8743fea7e00ba0036af8654d0347"
require «doc-gen4» from git require «doc-gen4» from git
"https://github.com/jrpotter/bookshelf-docgen.git" @ "https://github.com/jrpotter/bookshelf-docgen.git" @
"93aa96a2b6318d78cc505e45f6538d507ce0834c" "291f71e6c520751d52832c95f47cbc059c77bfa7"
@[default_target] @[default_target]
lean_lib «Bookshelf» { lean_lib «Bookshelf» {