Skip to content

Commit

Permalink
Update README.md and features.md (#489)
Browse files Browse the repository at this point in the history
* update the readme

* note about liveness
  • Loading branch information
konnov authored Jan 25, 2021
1 parent 43dc41c commit 472f922
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,20 @@ To try the latest cool features, check out the [unstable branch].
- Consult the (WIP) [Idioms for writing better TLA+][idioms].
- Consult the (WIP) [TLA+ language manual for engineers][language-manual].

## Website

[apalache.informal.systems][] is the main website of the project.

## Community

- Join the chat in the [Apalache zulip stream].
- [Contribute](./CONTRIBUTING.md) to the development of Apalache.

## Industrial examples

- Check [Light client specs] and [Model-based testing] of the Tendermint
light client.

- Check [Tendermint specs] to see how we use TLA+ and Apalache at Informal to
design and specify protocols for the [Tendermint blockchain].

Expand Down Expand Up @@ -126,3 +133,6 @@ Our old website is still available at https://forsyte.at/research/apalache/ .
[user-manual-docker]: https://apalache.informal.systems/docs/apalache/installation/docker.html
[language-manual]: https://apalache.informal.systems/docs/lang/index.html
[idioms]: https://apalache.informal.systems//docs/idiomatic/index.html
[Light client specs]: https://github.com/tendermint/spec/tree/master/rust-spec/lightclient/verification
[Model-based testing]: https://github.com/informalsystems/tendermint-rs/tree/master/light-client/tests/support/model_based#light-client-model-based-testing-guide
[apalache.informal.systems]: https://apalache.informal.systems
11 changes: 11 additions & 0 deletions docs/src/apalache/features.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
Here is the list of the TLA+ language features that are currently supported by Apalache, following the [Summary of TLA+][cheat].

## Safety vs. Liveness

At the moment, Apalache is able to check invariants and inductive invariants.
It means that you can only check safety with Apalache, unless you employ
[liveness-to-safety] transformation in your spec. It does not support
liveness properties. If you really like to see liveness implemented, upvote
the [liveness feature].

## Language

### Module-Level constructs
Expand Down Expand Up @@ -166,3 +174,6 @@ Not supported, not a priority


[cheat]: https://lamport.azurewebsites.net/tla/summary.pdf
[liveness-to-safety]: https://www.sciencedirect.com/science/article/pii/S1571066104804109?via%3Dihub
[liveness feature]: https://github.com/informalsystems/apalache/issues/488

0 comments on commit 472f922

Please sign in to comment.