Skip to content

Commit

Permalink
remove documents from the root of the project
Browse files Browse the repository at this point in the history
  • Loading branch information
oxarbitrage committed Oct 26, 2024
1 parent ca4271e commit 1bb02d8
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 2 deletions.
Binary file removed Blockchain.pdf
Binary file not shown.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ This is an ongoing project, and comments or contributions are highly encouraged.

## Project Structure

The project consists of several files, with `p2p.tla` being the core specification. The algorithm is implemented in PlusCal.
The project consists of several files, with `p2p.tla` being the core specification. The distriubted algorithm is implemented in PlusCal while additional files are pure TLA+.

- [Spec](p2p.tla)
- [PDF]()
- [PDF's](documents/)
- [Blockchain](Blockchain.tla)
- [Operators](Operators.tla)
- [Utils](Utils.tla)
Expand Down
5 changes: 5 additions & 0 deletions documents/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Documents

We automatically generate PDF documents for each TLA+ file in the project. This is managed by the [Generate PDF Workflow](../.github/workflows/tla-pdf-generator.yml).

A new PDF document is generated whenever any TLA+ file in the project is modified.
Binary file removed p2p.pdf
Binary file not shown.

0 comments on commit 1bb02d8

Please sign in to comment.