From 0b4c2f14fe7366c92374c729d9f9cb32c217d2f6 Mon Sep 17 00:00:00 2001
From: Robert Virding <rvirding@gmail.com>
Date: Fri, 8 Feb 2019 10:31:35 +0100
Subject: [PATCH] Move module documentation to separate files (#23)

---
 README.md             | 87 ++-----------------------------------------
 docs/aeso_compiler.md | 86 ++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 90 insertions(+), 83 deletions(-)
 create mode 100644 docs/aeso_compiler.md

diff --git a/README.md b/README.md
index b8d9720..2592113 100644
--- a/README.md
+++ b/README.md
@@ -6,90 +6,11 @@ For more information about æternity smart contracts and the sophia language see
 
 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 system to compile contracts coded in sophia which
+also be included in other systems to compile contracts coded in sophia which
 can then be loaded into the æternity system.
 
-## Modules
+## Interface Modules
 
-### aeso_compiler
+The basic modules for interfacing the compiler:
 
-The Sophia compiler
-
-### Description
-
-This module provides the interface to the standard Sophia compiler. It
-returns the compiled module in a map which can then be loaded.
-
-### Types
-```erlang
-contract_string() = string() | binary()
-contract_map() = #{bytecode => binary(),
-                   compiler_version => string(),
-                   contract_souce => string(),
-                   type_info => type_info()}
-type_info()
-errorstring() = binary()
-```
-### Exports
-
-#### file(File)
-#### file(File, Options) -> CompRet
-#### from_string(ContractString, Options) -> CompRet
-
-Types
-
-``` erlang
-ContractString = contract_string()
-Options = [Option]
-CompRet = {ok,ContractMap} | {error,ErrorString}
-ContractMap = contract_map()
-ErrorString = errorstring()
-```
-
-Compile a contract defined in a file or in a string.
-
-The **pp_** options all print to standard output the following:
-
-`pp_sophia_code` - print the input Sophia code.
-
-`pp_ast` - print the AST of the code
-
-`pp_types` - print information about the types
-
-`pp_typed_ast` - print the AST with type information at each node
-
-`pp_icode` - print the internal code structure
-
-`pp_assembler` - print the generated assembler code
-
-`pp_bytecode` - print the bytecode instructions
-
-#### check_call(ContractString, Options) -> CheckRet
-
-Types
-```
-ContractString = string() | binary()
-CheckRet = {ok,string(),{Types,Type | any()},Terms} | {error,Term}
-Types = [Type]
-Type = term()
-```
-Check a call in contract through the `__call` function.
-
-#### sophia_type_to_typerep(String) -> TypeRep
-
-Types
-``` erlang
- {ok,TypeRep} | {error, badtype}
-```
-
-Get the type representation of a type declaration.
-
-#### version() -> Version
-
-Types
-
-``` erlang
-Version = integer()
-```
-
-Get the current version of the Sophia compiler.
+* [aeso_compiler: the Sophia compiler](./docs/aeso_compiler.md)
diff --git a/docs/aeso_compiler.md b/docs/aeso_compiler.md
new file mode 100644
index 0000000..8bb0f38
--- /dev/null
+++ b/docs/aeso_compiler.md
@@ -0,0 +1,86 @@
+# aeso_compiler
+
+### Module
+
+### aeso_compiler
+
+The Sophia compiler
+
+### Description
+
+This module provides the interface to the standard Sophia compiler. It
+returns the compiled module in a map which can then be loaded.
+
+### Types
+``` erlang
+contract_string() = string() | binary()
+contract_map() = #{bytecode => binary(),
+                   compiler_version => string(),
+                   contract_souce => string(),
+                   type_info => type_info()}
+type_info()
+errorstring() = binary()
+```
+### Exports
+
+#### file(File)
+#### file(File, Options) -> CompRet
+#### from_string(ContractString, Options) -> CompRet
+
+Types
+
+``` erlang
+ContractString = contract_string()
+Options = [Option]
+CompRet = {ok,ContractMap} | {error,ErrorString}
+ContractMap = contract_map()
+ErrorString = errorstring()
+```
+
+Compile a contract defined in a file or in a string.
+
+The **pp_** options all print to standard output the following:
+
+`pp_sophia_code` - print the input Sophia code.
+
+`pp_ast` - print the AST of the code
+
+`pp_types` - print information about the types
+
+`pp_typed_ast` - print the AST with type information at each node
+
+`pp_icode` - print the internal code structure
+
+`pp_assembler` - print the generated assembler code
+
+`pp_bytecode` - print the bytecode instructions
+
+#### check_call(ContractString, Options) -> CheckRet
+
+Types
+```
+ContractString = string() | binary()
+CheckRet = {ok,string(),{Types,Type | any()},Terms} | {error,Term}
+Types = [Type]
+Type = term()
+```
+Check a call in contract through the `__call` function.
+
+#### sophia_type_to_typerep(String) -> TypeRep
+
+Types
+``` erlang
+ {ok,TypeRep} | {error, badtype}
+```
+
+Get the type representation of a type declaration.
+
+#### version() -> Version
+
+Types
+
+``` erlang
+Version = integer()
+```
+
+Get the current version of the Sophia compiler.