Commits

Anonymous committed 0ef2ff1

Add a bit more to the README.

  • Participants
  • Parent commits 42ef445

Comments (0)

Files changed (1)

 
 This repository holds a package that is a SCons tool for working with Erlang code.
 
+This tool provides the _Erlang_ and _EDoc_ builders:
+
+ *  _Erlang_ is used to compile Erlang source to create the *beam* files.
+ *  _EDoc_ is used to create the documentation generated from the source code. 
+
+For example
+
+    environment = Environment ( tools = [ 'erlang' ] )
+    environment.Erlang ( 'example.erl' ) 
+
 # Installation
 
 There are many ways of installing this depending on the use case.  Rather than explain here (and replicate