From 50179d29185eaa329dd752cb5edd581df5dab5fe Mon Sep 17 00:00:00 2001 From: Robert Virding Date: Tue, 8 Jan 2019 17:14:10 +0100 Subject: [PATCH] Update README.md to something a bit more helpful --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a592b1a..2632f62 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,10 @@ -THIS IS VERY MUCH *WIP* SO BEWARE! +# aesophia -aesophia -===== +This is the __sophia__ compiler for the æternity system which compiles contracts written in __sophia__ code to the æternity VM code. -An OTP application +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). -Build ------ - - $ rebar3 compile +It is an OTP application written in Erlang and is by default included in +[æternity Epoch](https://github.com/aeternity/epoch). However, it can +also be included in other system to compile contracts coded in sophia which +can then be loaded into the æternity system.