Skip to content

Commit 4ffa620

Browse files
committed
README: updated description of TLAPS vs TLAPM
Signed-off-by: Andrew Helwer <[email protected]>
1 parent c8ca095 commit 4ffa620

File tree

3 files changed

+29
-28
lines changed

3 files changed

+29
-28
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
Contributing to TLAPM
1+
Contributing to TLAPS
22
---------------------
33

44
TL;DR: engage maintainers early & often, be surgical in your changes, and write lots of tests.
55

66
We welcome contributions to this open source project!
77
Before beginning work, please take some time to familiarize yourself with our development processes and expectations.
8-
TLAPM is used to validate safety-critical systems, so maintaining quality is paramount.
8+
TLAPS is used to validate safety-critical systems, so maintaining quality is paramount.
99
The existing code can also be quite complicated to modify and it is difficult to review changes effectively.
1010
So, there are several practices that are necessary for having a good contribution experience.
1111
The last thing anybody wants is for you to feel as though you have wasted your time!
@@ -53,7 +53,7 @@ Contribution Possibilities
5353
These tools have a large number existing issues to fix, which you can see on the repo's [issues tab](https://github.com/tlaplus/tlapm/issues).
5454

5555
Non-code contributions are particularly desired!
56-
TLAPM documentation needs a lot of work.
56+
TLAPS documentation needs a lot of work.
5757
The docs are hosted at https://proofs.tlapl.us and live in this repo in the [doc/web](doc/web) directory.
5858

5959
For new features, there are a number of [substantial improvements we'd like to see implemented](todo.txt).

DEVELOPING.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ It uses the [Dune](https://dune.build/) build system for OCaml, with [Make](http
88
Release Channels
99
----------------
1010
Past versioned releases can be downloaded from the [GitHub Releases page](https://github.com/tlaplus/tlapm/releases).
11-
For the latest development version, download the builds attached to the [1.6.0 rolling pre-release](https://github.com/tlaplus/tlapm/releases/tag/1.6.0-pre) or follow the instructions below to build TLAPM from source.
11+
For the latest development version, download the builds attached to the [1.6.0 rolling pre-release](https://github.com/tlaplus/tlapm/releases/tag/1.6.0-pre) or follow the instructions below to build TLAPS from source.
1212

1313
Dependencies
1414
------------
15-
TLAPM development & use is only supported on Unix-like systems, such as:
15+
TLAPS development & use is only supported on Unix-like systems, such as:
1616
* Any modern Linux
1717
* macOS
1818
* Windows Subsystem for Linux
1919

20-
For building TLAPM, some Linux distros require additional packages beyond the base install; on Debian/Ubuntu:
20+
For building TLAPS, some Linux distros require additional packages beyond the base install; on Debian/Ubuntu:
2121
```sh
2222
apt install zlib1g-dev gawk time
2323
```
@@ -38,7 +38,7 @@ eval $(opam env --switch=5.1.0)
3838
```
3939
You can put the `eval` statement in your shell init file (`~/.bashrc` or similar) to ensure your shell always has an active OCaml environment.
4040

41-
Build & Install TLAPM
41+
Build & Install TLAPS
4242
---------------------
4343
Clone this repo & open a shell in its root.
4444
Install OCaml package dependencies with:
@@ -49,26 +49,26 @@ make opam-deps-opt
4949
```
5050
Package dependencies are unfortunately not yet declarative, but [will be in the future](https://github.com/tlaplus/tlapm/issues/158#issuecomment-2455455589).
5151

52-
Compile the embedded dependencies and TLAPM with:
52+
Compile the embedded dependencies and TLAPS with:
5353
```sh
5454
make
5555
```
56-
Install TLAPM to your local OCaml environment with:
56+
Install TLAPS to your local OCaml environment with:
5757
```sh
5858
make install
5959
```
6060
This should put `tlapm` on your path from your local OCaml environment, but if not you can run:
6161
```sh
6262
opam exec -- tlapm --help
6363
```
64-
Compile a TLAPM release distributable with:
64+
Compile a TLAPS release distributable with:
6565
```sh
6666
make release
6767
```
6868
This will output a file to `_build/tlaps-$GIT_COMMMIT_HASH-$ARCH-$OS.tar.gz`; for example, running `make release` on Linux produced the file `_build/tlaps-a7a3a0a-x86_64-linux-gnu.tar.gz`.
69-
This file can be used the same as any downloaded TLAPM release.
69+
This file can be used the same as any downloaded TLAPS release.
7070

71-
Test TLAPM
71+
Test TLAPS
7272
----------
7373
You can run all tests with:
7474
```sh
@@ -102,26 +102,26 @@ There are other files and directories beyond these, but these are the most impor
102102
├── README.md # Basic info about the project
103103
├── DEVELOPING.md # This document
104104
├── CONTRIBUTING.md # How to contribute to the project
105-
├── hints.txt # Some tips on effectively writing TLAPM proofs
105+
├── hints.txt # Some tips on effectively writing TLAPS proofs
106106
├── todo.txt # Feature wishlist
107107
├── dune-project # Top-level Dune project file (generates tlapm.opam)
108108
├── Makefile # Makefile for installing dependencies & launching Dune builds
109109
├── index.html # proofs.tlapl.us root page; currently redirects to docs
110110
├── deps/ # Makefiles for dependencies (LS4, Isabelle, Z3, etc.)
111-
├── doc/ # Sources for TLAPM documentation on proofs.tlapl.us
111+
├── doc/ # Sources for TLAPS documentation on proofs.tlapl.us
112112
├── examples/ # Some example proofs that can be used as tests
113113
├── isabelle/ # Embedding of non-temporal parts of TLA⁺ in Isabelle
114-
├── library/ # The TLAPM standard modules for TLA⁺
114+
├── library/ # The TLAPS standard modules for TLA⁺
115115
├── translate/ # External library for translating temporal logic formulas to LS4
116116
├── zenon/ # The vendored source code of the Zenon theorem prover
117117
├── misc/
118-
│ └── tla_mode/ # A TLAPM mode for Emacs
119-
├── lsp/ # A language server for checking TLA⁺ proofs with TLAPM
118+
│ └── tla_mode/ # A TLAPS mode for Emacs
119+
├── lsp/ # A language server for checking TLA⁺ proofs with TLAPS
120120
├── src/ # Main TLAPM source code directory
121121
│ ├── dune # Dune build file
122122
│ ├── tlapm.ml # The main entrypoint to the TLAPM CLI
123123
│ └── tlapm_lib.mli # Main interface for TLAPM when used as a library
124-
├── test/ # Tests for TLAPM
124+
├── test/ # Tests for TLAPS
125125
└── .github/
126126
├── CODE_OF_CONDUCT.md # The code of conduct
127127
└── workflows/ # GitHub CI workflow definition files

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
1-
The TLA⁺ Proof Manager (`tlapm`)
2-
================================
1+
The TLA⁺ Proof System
2+
=====================
33
[![Build & Test](https://github.com/tlaplus/tlapm/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/tlaplus/tlapm/actions/workflows/ci.yml)
44

5-
This repository hosts the TLA⁺ Proof Manager TLAPM, formerly known as TLAPS.
6-
TLAPM translates TLA⁺ proof constructs into forms understood by an array of backend solvers & theorem provers, enabling machine-checked proofs of correctness for TLA⁺ specifications.
7-
TLAPM's development is managed by the [TLA⁺ Foundation](https://foundation.tlapl.us/).
5+
This repository hosts what is collectively called the TLA⁺ Proof System, or TLAPS.
6+
It consists of the TLA⁺ Proof Manager `tlapm` that interprets TLA⁺ proofs & manages their state, as well as interfaces to automatic backend provers such as [SMT](https://en.wikipedia.org/wiki/Satisfiability_modulo_theories) solvers like [Z3](https://github.com/Z3Prover/z3), the [tableau](https://en.wikipedia.org/wiki/Method_of_analytic_tableaux) prover [Zenon](https://github.com/zenon-prover/zenon), the [Isabelle](https://isabelle.in.tum.de/)/TLA⁺ object logic, and the LS4 decision procedure for [propositional temporal logic](https://plato.stanford.edu/entries/logic-temporal/).
7+
8+
TLAPS development is managed by the [TLA⁺ Foundation](https://foundation.tlapl.us/).
89
For documentation, see http://proofs.tlapl.us.
910
For information on TLA⁺ generally, see http://tlapl.us.
1011

1112
Installation & Use
1213
------------------
1314
Past versioned releases can be downloaded from the [GitHub Releases page](https://github.com/tlaplus/tlapm/releases).
14-
For the latest development version, download the builds attached to the [1.6.0 rolling pre-release](https://github.com/tlaplus/tlapm/releases/tag/1.6.0-pre) or follow the instructions in [`DEVELOPING.md`](DEVELOPING.md) to build TLAPM from source.
15+
For the latest development version, download the builds attached to the [1.6.0 rolling pre-release](https://github.com/tlaplus/tlapm/releases/tag/1.6.0-pre) or follow the instructions in [`DEVELOPING.md`](DEVELOPING.md) to build TLAPS from source.
1516

16-
Once TLAPM is installed, run `tlapm --help` to see documentation of the various command-line parameters.
17+
Once TLAPS is installed, run `tlapm --help` to see documentation of the various command-line parameters.
1718
Check the proofs in a simple example spec in this repo by running:
1819
```sh
1920
tlapm examples/Euclid.tla
@@ -22,14 +23,14 @@ Documentation is hosted at http://proofs.tlapl.us, or can be viewed locally from
2223

2324
Developing & Contributing
2425
-------------------------
25-
For instructions on building & testing TLAPM as well as setting up a development environment, see [DEVELOPING.md](DEVELOPING.md).
26+
For instructions on building & testing TLAPS as well as setting up a development environment, see [DEVELOPING.md](DEVELOPING.md).
2627

2728
We welcome your contributions to this open source project!
28-
TLAPM is used in safety-critical systems, so we have a contribution process in place to ensure quality is maintained; read [CONTRIBUTING.md](CONTRIBUTING.md) before beginning work.
29+
TLAPS is used in safety-critical systems, so we have a contribution process in place to ensure quality is maintained; read [CONTRIBUTING.md](CONTRIBUTING.md) before beginning work.
2930

3031
Authors
3132
-------
32-
The following people were instrumental in creating TLAPM:
33+
The following people were instrumental in creating TLAPS:
3334
- [Kaustuv Chaudhuri](https://chaudhuri.info/) (@[chaudhuri](https://github.com/chaudhuri))
3435
- Denis Cousineau
3536
- [Damien Doligez](http://cambium.inria.fr/~doligez/) (@[damiendoligez](https://github.com/damiendoligez))

0 commit comments

Comments
 (0)