# Scribble

## Scribble

- [Introduction](https://docs.scribble.codes/master.md): Documentation for https://github.com/ConsenSys/Scribble
- [Scribble Generator](https://docs.scribble.codes/scribble-generator.md): Annotate your existing property tests
- [Installation](https://docs.scribble.codes/tool/installation.md): How to install Scribble
- [CLI Usage](https://docs.scribble.codes/tool/cli-usage.md)
- [Arm and disarm](https://docs.scribble.codes/tool/cli-usage/arm-and-disarm.md)
- [Assertion Checking Modes](https://docs.scribble.codes/tool/assertion-checking-modes.md)
- [Instrumented Code](https://docs.scribble.codes/tool/instrumented-code.md)
- [Debugging Instrumented Code](https://docs.scribble.codes/tool/instrumented-code/debugging-instrumented-code.md)
- [JSON output specification](https://docs.scribble.codes/tool/json-output-specification.md)
- [FAQ](https://docs.scribble.codes/tool/faq.md)
- [Introduction](https://docs.scribble.codes/language/introduction.md)
- [Annotations](https://docs.scribble.codes/language/annotations.md)
- [Function Annotations](https://docs.scribble.codes/language/annotations/lang-function-specifications.md): Function specifications are used to specify the behaviour of a single function.
- [State Variable Annotations](https://docs.scribble.codes/language/annotations/state-variable-specifications.md): Properties that hold when state variables are written to
- [Contract Invariants](https://docs.scribble.codes/language/annotations/invariants.md): Properties that should always hold.
- [Scribble Functions](https://docs.scribble.codes/language/annotations/user-defined-functions.md): How to write User defined functions
- [Assert Annotations](https://docs.scribble.codes/language/annotations/assert-annotations.md): Checking properties in the middle of a function
- [Macros](https://docs.scribble.codes/language/annotations/macros.md): Annotations for standardized smart contracts
- [Hints](https://docs.scribble.codes/language/annotations/hints.md): Providing hints to backend tools with annotations
- [Expressions](https://docs.scribble.codes/language/keywords.md): How to write Scribble expressions
- [Quantification](https://docs.scribble.codes/language/keywords/quantification.md): Quantification allows us to talk about all values in a set
- [Property Checking with Scribble and MythX](https://docs.scribble.codes/tutorials/property-checking-with-scribble-and-mythx.md)
- [Property Checking with Scribble and Mythril](https://docs.scribble.codes/tutorials/property-checking-with-scribble-and-mythril.md)
- [In-place testing with Scribble](https://docs.scribble.codes/tutorials/in-place-testing-with-scribble.md)