Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Antoine Mercadal committed Nov 1, 2010
1 parent b5d17d7 commit a3f11a3
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,19 +1,35 @@
# MessageBoard


## What is MessageBoard ?

MessageBoard is a set of classes uses to easily create a stacked message board
This Library is used by Archipel Project.
This library is released under LGPL license. Feel
free to use it or improve it.


## Build

To build TNKit you can type

# jake debug ; jake release


## Quick Start

Simply include the MessageBoard framework in your Frameworks directory and include MessageBoard.j

@import <MessageBoard/MessageBoard.j>


## Demo application

You can see a demo application here: [Demo](http://github.com/primalmotion/MessageBoard-Example/)


## Documentation

To generate the documentation execute the following :

# doxygen MessageBoard.doxygen

0 comments on commit a3f11a3

Please sign in to comment.