--- README.asciidoc | 70 ------------------------------------------------------- README.md | 51 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+), 70 deletions(-) delete mode 100644 README.asciidoc create mode 100644 README.md
diff --git a/README.asciidoc b/README.asciidoc deleted file mode 100644 index 328d33c..0000000 --- a/README.asciidoc +++ /dev/null @@ -1,70 +0,0 @@ -// -*- mode: doc -*- - -README -====== -:Author: Eric Merritt [email protected] -:website: http://wwww.erlware.org - -What is Sinan -------------- - -Sinan is a build tool designed to build Erlang/OTP Projects, Releases -and Applications. Sinan leverages the metadata artifacts provided by -OTP to do a good job building, testing, releasing, etc with very -little or no additional input from the developer. - -Quick Start ------------ - -To get started just cd into an OTP Application and type - -[source,sh] ----------------------------------------------------------------------- - sinan build ----------------------------------------------------------------------- - -This will give you an fully built OTP application under the _build -directory. You can then run the command - -[source,sh] ----------------------------------------------------------------------- - sinan shell ----------------------------------------------------------------------- - -to get an erlang shell with all the paths pointing correctly to the -various parts of your system. - -If you want to get adventurous you can run all the eunit tests in your -app by running: - -[source,sh] ----------------------------------------------------------------------- - sinan test ----------------------------------------------------------------------- - -and finially, if you want to package up a normal erlang release -tarball you can run - -[source,sh] ----------------------------------------------------------------------- - sinan dist ----------------------------------------------------------------------- - -The tarball will end up in - -[source,sh] ----------------------------------------------------------------------- - <project-root>/_build/developement/tar/<app-name>-<app-vsn>.tar.gz ----------------------------------------------------------------------- - -To get a list of all tasks currently available run the command - -[source,sh] ----------------------------------------------------------------------- - sinan help ----------------------------------------------------------------------- - -Hopefully thats enough to get you started, but sinan has many options -to do various things with projects from small single app projects to -very large multiple app projects. To get more information take a look -at the sinan manual. diff --git a/README.md b/README.md new file mode 100644 index 0000000..3f88d21 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +// -*- mode: doc -*- + +README +====== + + +What is Sinan +------------- + +Sinan is a build tool designed to build Erlang/OTP Projects, Releases +and Applications. Sinan leverages the metadata artifacts provided by +OTP to do a good job building, testing, releasing, etc with very +little or no additional input from the developer. + +Quick Start +----------- + +To get started just cd into an OTP Application and type + + sinan build + +This will give you an fully built OTP application under the _build +directory. You can then run the command + + sinan shell + +to get an erlang shell with all the paths pointing correctly to the +various parts of your system. + +If you want to get adventurous you can run all the eunit tests in your +app by running: + + sinan test + +and finially, if you want to package up a normal erlang release +tarball you can run + + sinan dist + +The tarball will end up in + + <project-root>/_build/developement/tar/<app-name>-<app-vsn>.tar.gz + +To get a list of all tasks currently available run the command + + sinan help + +Hopefully thats enough to get you started, but sinan has many options +to do various things with projects from small single app projects to +very large multiple app projects. To get more information take a look +at the sinan manual. -- 1.7.5.2 -- You received this message because you are subscribed to the Google Groups "erlware-dev" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/erlware-dev?hl=en.
