-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
14 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# elm-impress | ||
A port of [impress.js](https://github.com/impress/impress.js) by [@bartaz](https://github.com/bartaz) to [Elm](elm-lang.org) | ||
|
||
## Status | ||
The software is usable. | ||
It is as simple as creating a declarative list of *steps* in a separate Elm file, wiring it up in the `Main` module. | ||
In Elm terms, each step is defined as a [record type](http://elm-lang.org/guide/core-language#records) with default values, | ||
and ends up being turned into an [`Html`](https://github.com/evancz/elm-html) type by the `elm-impress` engine. | ||
|
||
See the `Demo` folder for an example, taken from [the official impress.js demo](http://impress.github.io/impress.js). | ||
|
||
## ToDo | ||
- [ ] Provide more details on usage | ||
- [ ] Describe differences vs. the original JavaScript version (very few indeed, and minor too) |