Skip to content

Commit

Permalink
added a note about being 2D
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisPritchard committed Apr 13, 2019
1 parent 7189a07 commit fc5ab0c
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

In this way, you can develop games using the excellent Elmish architecture, with all the power of an XNA renderer! You can also convert existing Elmish applications to use Xelmish by rewriting their view functions.

To use Xelmish, the Elmish program must provide a view function that returns a list of 'viewables', functions which take an XNA SpriteBatch. A set of common such functions like colour, image and text are provided in the Xelmish Viewables helper module.

Xelmish is for **2D games** (the SpriteBatch object is for drawing textures, not rendering vertices). Hopefully it allows users to develop such games rapidly using the Elm architecture and F#!

## Simple Example of Usage

## Development Info
Expand Down

0 comments on commit fc5ab0c

Please sign in to comment.