From b7c8b13caee43a3cdc815649edc1e044e644c1ac Mon Sep 17 00:00:00 2001 From: radrow Date: Thu, 27 Feb 2020 13:42:10 +0100 Subject: [PATCH] Update readme --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2f8bf0c..95fed2a 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,19 @@ This is the __sophia__ compiler for the æternity system which compiles contracts written in __sophia__ code to the æternity VM code. -For more information about æternity smart contracts and the sophia language see [Smart Contracts](https://github.com/aeternity/protocol/blob/master/contracts/contracts.md) and the [Sophia Language](https://github.com/aeternity/protocol/blob/master/contracts/sophia.md). - It is an OTP application written in Erlang and is by default included in [the æternity node](https://github.com/aeternity/epoch). However, it can also be included in other systems to compile contracts coded in sophia which can then be loaded into the æternity system. + +## Documentation + +* [Smart Contracts on aeternity Blockchain](https://github.com/aeternity/protocol/blob/master/contracts/contracts.md). +* [Sophia Documentation](https://github.com/aeternity/aesophia/blob/master/docs/sophia.md). +* [Sophia Standard Library](https://github.com/aeternity/aesophia/blob/master/docs/sophia_stdlib.md). + + ## Versioning `aesophia` has a version that is only loosely connected to the version of the @@ -17,6 +23,7 @@ minor/patch version. The `aesophia` compiler version MUST be bumped whenever there is a change in how byte code is generated, but it MAY also be bumped upon API changes etc. + ## Interface Modules The basic modules for interfacing the compiler: