Skip to content

Commit

Permalink
document package
Browse files Browse the repository at this point in the history
  • Loading branch information
kmcallister committed Oct 27, 2011
1 parent 7d0896e commit 86a3814
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
FIXME
Propane is a system for functional synthesis of images and animations.

Documentation is hosted at http://hackage.haskell.org/package/FIXME
Documentation is [FIXME: will be] hosted at http://hackage.haskell.org/package/propane

To build the documentation yourself, run

$ cabal configure && cabal haddock --hyperlink-source

This will produce HTML documentation under dist/doc/html/FIXME
This will produce HTML documentation under dist/doc/html/propane
21 changes: 18 additions & 3 deletions propane.cabal
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,29 @@ name: propane
version: 0.1
license: BSD3
license-file: LICENSE
synopsis: FIXME
category: FIXME
synopsis: Functional synthesis of images and animations
category: Graphics
author: Keegan McAllister <mcallister.keegan@gmail.com>
maintainer: Keegan McAllister <mcallister.keegan@gmail.com>
build-type: Simple
cabal-version: >=1.6
description:
FIXME
Propane is a system for synthesizing images and animations, in the spirit
of Pan (<http://conal.net/Pan/>) and many other projects. The core idea is
that an image is a function assigning a colour to each point in the plane.
Similarly, an animation assigns an image to each point in time. Haskell's
tools for functional and declarative programming can be used directly on
images and animations.
.
Several examples are provided, in the @examples/@ directory.
.
Propane uses the Repa array library. This means that Propane automatically
uses multiple CPU cores for rendering, provided the program is compiled and
run with threads enabled. That said, the implementation has not yet been
optimized for speed.
.
Propane is a modest toy right now, but there are vague plans to make it
do fancy things. Please contact the author with suggestions or code!

extra-source-files:
README
Expand Down

0 comments on commit 86a3814

Please sign in to comment.