262452fb70
* docs: restructuring & introduction of mkdocs with versioning provided by mike * docs: ad repositories section to sophia examples * docs: refactoring and consistent naming of æternity * docs: hint for new file destination * docs: revert capital letter * docs: accept proposed changes * docs: fix anchors in stdlib
35 lines
1.4 KiB
Markdown
35 lines
1.4 KiB
Markdown
# aesophia
|
|
|
|
This is the __sophia__ compiler for the æternity system which compiles contracts written in __sophia__ to [FATE](https://github.com/aeternity/protocol/blob/master/contracts/fate.md) instructions.
|
|
|
|
The compiler is currently being used three places
|
|
- [The command line compiler](https://github.com/aeternity/aesophia_cli)
|
|
- [The HTTP compiler](https://github.com/aeternity/aesophia_http)
|
|
- In [æternity node](https://github.com/aeternity/aeternity) tests
|
|
|
|
## Documentation
|
|
|
|
* [Introduction](docs/index.md)
|
|
* [Syntax](docs/sophia_syntax.md)
|
|
* [Features](docs/sophia_features.md)
|
|
* [Standard library](docs/sophia_stdlib.md)
|
|
* [Contract examples](docs/sophia_examples.md)
|
|
|
|
Additionally you can check out the [contracts section](https://github.com/aeternity/protocol/blob/master/contracts/contracts.md) of the æternity blockchain specification.
|
|
|
|
## Versioning
|
|
|
|
Versioning should follow the [semantic versioning](https://semver.org/spec/v2.0.0) guidelines. Id est, given a version number MAJOR.MINOR.PATCH, increment the:
|
|
|
|
- MAJOR version when you make incompatible API changes
|
|
- MINOR version when you add functionality in a backwards compatible manner
|
|
- PATCH version when you make backwards compatible bug fixes
|
|
|
|
|
|
## Interface Modules
|
|
|
|
The basic modules for interfacing the compiler:
|
|
|
|
* [aeso_compiler: the Sophia compiler](docs/aeso_compiler.md)
|
|
* [aeso_aci: the ACI interface](docs/aeso_aci.md)
|