visualproof 0.2.0 → 0.3.0

package/README.md

@@ -1,13 +1,45 @@
 # VisualProof
 
-**See what a Lean theorem actually rests on.**
+<p align="center">
+  <a href="https://github.com/math-inc/Sphere-Packing-Lean"><img src="docs/images/artwork-sphere-packing.webp" width="19%" alt="Sphere Packing"></a>
+  <a href="https://github.com/leanprover-community/flt-regular"><img src="docs/images/artwork-flt-regular.webp" width="19%" alt="FLT Regular"></a>
+  <a href="https://github.com/AlexKontorovich/PrimeNumberTheoremAnd"><img src="docs/images/artwork-prime-numbers.webp" width="19%" alt="Prime Numbers"></a>
+  <a href="https://github.com/openai/NavierStokesAndEuler"><img src="docs/images/artwork-navier-stokes.webp" width="19%" alt="Navier–Stokes"></a>
+  <a href="https://github.com/cedar-policy/cedar-spec"><img src="docs/images/artwork-cedar.webp" width="19%" alt="Cedar"></a>
+</p>
+<p align="center"><sub>Five Lean codebases, drawn by <code>visualproof artwork</code>.</sub></p>
+
+[![VisualProof on flt-regular, from the live demo: the TCB of flt_regular, its key declarations approved, an approval recorded at a meeting, the review plan pinned beside it](docs/images/board.webp)](https://visualproof-demo.yingte.io)
+
+<p align="center"><b>Live demo: <a href="https://visualproof-demo.yingte.io">https://visualproof-demo.yingte.io</a></b><br><sub>flt-regular in the middle of a review by three people and an AI assistant, read-only</sub></p>
+
+## Try it
+
+Set up in your Lean codebase with agent prompt:
+```text
+Set up VisualProof (https://github.com/LucianoXu/VisualProof) for my Lean project, and give me the address to open.
+```
+
+Set up manually:
+```bash
+npm install --global visualproof
+cd my-lean-project && lake build
+visualproof serve .
+```
+
+It needs Node, elan and Poppler ([Requirements](#requirements)).
+
+## See what a Lean theorem actually rests on
 
 Lean checks that a proof is correct. It cannot check that the theorem says what you mean: that the
 definitions in its statement mean what their names suggest. VisualProof shows exactly which
 definitions those are, so that people, and AI agents, can read them, review them together, and
 keep a record of the review.
 
-<!-- A screenshot or a short video of the board goes here. -->
+On [flt-regular](https://github.com/leanprover-community/flt-regular), Fermat's Last Theorem for
+regular primes. Of the project's
+273 declarations, two light up besides the theorem, `IsRegularPrime` and `IsRegularNumber`: with
+the Mathlib definitions they use, they are what you need to read to believe what it says.
 
 ## What it does
 
@@ -24,6 +56,8 @@ keep a record of the review.
 - **History**: every build is kept, and a past board can be browsed.
 - **A printed document** of what a view holds: definitions in full, proofs left out, typeset with
   XeLaTeX.
+- **A picture of the board**, PNG or SVG up to poster size: from the page, from an agent's link, or
+  without a browser (`visualproof artwork <project> --recipe recipe.json`).
 
 ## Requirements
 
@@ -36,28 +70,6 @@ keep a record of the review.
 The project must have been built with `lake build`: VisualProof only reads what the build left,
 and never builds it.
 
-## Try it
-
-VisualProof is not on npm yet: install its `visualproof` command from a checkout, which packs it
-as npm would. Here it is on [flt-regular](https://github.com/leanprover-community/flt-regular),
-Fermat's Last Theorem for regular primes, built on Mathlib:
-
-```bash
-git clone https://github.com/LucianoXu/VisualProof
-(cd VisualProof && npm install && npm pack && npm install --global ./visualproof-*.tgz)
-
-git clone https://github.com/leanprover-community/flt-regular
-(cd flt-regular && git checkout bd81b78ba6 && lake exe cache get && lake build)
-
-visualproof doctor flt-regular     # what is missing, if anything, and what to do
-visualproof serve flt-regular
-```
-
-Open http://127.0.0.1:4173/. Choose the *Rests on* tool (`2`), find `flt_regular` with the search
-(`/`), and click it on the board. Of the project's 297 declarations, two light up besides the
-theorem: `IsRegularPrime` and `IsRegularNumber`. With the Mathlib definitions they use, they are
-what you need to read to believe what the theorem says.
-
 ## Where it keeps things
 
 It writes nothing into the project, and nothing into its own checkout. It keeps everything in two
@@ -96,5 +108,7 @@ speaks plain HTTP: beyond a trusted network, put a TLS proxy in front. [SECURITY
 ## License and citation
 
 VisualProof is licensed under Apache-2.0 ([LICENSE](LICENSE)). The fonts in `src/assets/fonts/`
-are JuliaMono, under the SIL Open Font License. If you use VisualProof in your work, please cite
-it ([CITATION.cff](CITATION.cff)).
+are JuliaMono; those in `src/assets/webfonts/`, which artworks are drawn in, are Source Sans 3,
+Source Serif 4, Jost, Noto Sans and Noto Sans Math. All are under the SIL Open Font License, whose
+text is beside them. If you use VisualProof in your work, please cite it
+([CITATION.cff](CITATION.cff)).

package/dist/assets/webfonts/LICENSE-Noto.txt

@@ -0,0 +1,95 @@
+Noto Sans: Copyright 2015 Google LLC. All Rights Reserved.
+Noto Sans Math: Copyright 2018 Google LLC. All Rights Reserved.
+(The files ttf/noto-sans.ttf and ttf/noto-sans-math.ttf hold a subset of each.)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.