logo

StartHere

Quick Start

If you want to jump right in and start coding:

  • Download the latest build
  • HelloWorld: learn to write hello world in the shell, as a script, and as a compiled pod
  • Tour: quick introduction to Fan's features by code example
  • docCookbook: snippets of example code for common tasks

Documentation Organization

All documentation and APIs are organized into modules called pods. The doc index is organized by manuals and APIs. APIs are the reference documentation for each public type generated from source (like Javadoc). Manuals group a set of chapters on a subject:

  • docIntro: general purpose introductory material
  • docLang: covers the language in depth
  • docTools: command line tools, unit testing, build toolkit
  • docLib: details on various pod libraries
  • docCookbook: example snippets of source code

Learning Fan

If you want to dig deep, then you'll probably want to look over docIntro to get a background. At some point you should consider reading docLang front to back - it is designed to be read as book. Once you start writing code, you'll find docCookbook and the reference APIs handy as you learn the standard libraries. When you start to develop real applications make sure to review how to write unit tests and build scripts.

Getting Involved

Right now we have a very primitive discussion list. Shortly we'll be upgrading our website rewritten in Fan itself with public discussion groups, blogs, and issue tracking - stay tuned.