README.md

   1 README
   2 ======
   3
   4
   5 What is Sinan
   6 -------------
   7
   8 Sinan is a build tool designed to build Erlang/OTP Projects, Releases
   9 and Applications. Sinan leverages the metadata artifacts provided by
  10 OTP to do a good job building, testing, releasing, etc with very
  11 little or no additional input from the developer.
  12
  13 Getting Sinan
  14 -------------
  15
  16 By far the easiest way to get sinan is to download it from the
  17 [downloads site](https://github.com/erlware/sinan/downloads).
  18
  19 More Information and FAQ
  20 ------------------------
  21
  22 Sinan has extensive further documentation in its
  23 [wiki on github](https://github.com/erlware/sinan/wiki). Check there
  24 for more information.
  25
  26 The Sinan FAQ is available at
  27 [here](https://github.com/erlware/sinan/wiki/FAQ).
  28
  29 ### The Community
  30
  31 A community exists around Sinan and the other Erlware projects. You
  32 may participate in the community and ask questions by joining the
  33 [erlware-questions](http://groups.google.com/group/erlware-questions)
  34 mailing list.
  35
  36
  37 Quick Start
  38 -----------
  39
  40 To get started just cd into an OTP Application and type
  41
  42     sinan build
  43
  44 This will give you an fully built OTP application under the _build
  45 directory. You can then run the command
  46
  47     sinan shell
  48
  49 to get an erlang shell with all the paths pointing correctly to the
  50 various parts of your system.
  51
  52 If you want to get adventurous you can run all the eunit tests in your
  53 app by running:
  54
  55     sinan test
  56
  57 and finially, if you want to package up a normal erlang release
  58 tarball you can run
  59
  60     sinan dist
  61
  62 The tarball will end up in
  63
  64     <project-root>/_build/<release-name>/tar/<app-name>-<app-vsn>.tar.gz
  65
  66 To get a list of all tasks currently available run the command
  67
  68     sinan help
  69
  70 Hopefully thats enough to get you started, but sinan has many options
  71 to do various things with projects from small single app projects to
  72 very large multiple app projects. To get more information take a look
  73 at the sinan manual.
  74