This directory contains the sources of Tezos, a distributed consensus platform with meta-consensus capability.
Information about the Tezos project, and the documentation of the Tezos software repository, can be found in the parent directory or online at https://tezos.gitlab.io/
An overview of the software architecture of Tezos is presented in the octopus drawing. That diagram describes at a high level (and a coarse grain) how the code in this directory is structured and how it works.
Dependencies on external components are mainly managed through the OPAM package manager. The parent directory (qv) also contains a few vendored external OCaml libraries.
Tezos is mainly implemented in the OCaml language.
The software architecture of Tezos at a finer grain is presented as a more detailed diagram. That diagram describes the sources at the level of OPAM packages (OPAM is the OCaml package manager).
To develop protocol enhancement proposals with a REPL, see tztop.
Tezos external and internal APIs are extensively documented at https://tezos.gitlab.io and more specifically therein:
- For installing and getting started with the Tezos software: consult the Introduction Tutorials
- For using the Tezos binaries: consult the User Documentation, and also the Command Line Interface (CLI) reference
- For developing Tezos applications: consult the Developer Tutorials, and also the RPC interface reference and OpenAPI specification
- For contributing to the platform or for integrating at a lower level with Tezos: consult the documentation of the Shell and of the various Protocols, and also the internal APIs in the Online OCaml Documentation