Document examples

[turion]

The Readme.md in rhine-examples should be updated to describe all examples briefly. Each example should have a more complete top level documentation.

[OsamaNabih]

Would I need to learn Haskell to do this? (I have looked at the code and I feel some of the files require knowledge of Haskell in order to give an accurate description of the functionality. I am asking if you agree with this statement or not)

[turion]

You could build and run the examples and try to understand them from that, that might already enough!

[OsamaNabih]

I have never dealt with Haskell and I am having problems running the examples. I've downloaded the Haskell environment and can run ghci from my terminal, but when I run an example it fails on the import FRP.rhine line and says module not found. Any hints?

[ggreif]

Do you have cabal installed?

If so, try on the command line

cabal update
cabal install rhine
cabal exec -- ghci <your-hs-file>

[OsamaNabih]

That worked, thank you.

[turion]

@ggreif thanks for the help! @OsamaNabih I assigned you for the issue. Let me know if you need any help.

[turion]

@ggreif 's instructions are excellent if you want to build your own examples. If you just want to run the existing examples, you can enter the rhine-examples directory and run - as the last command - cabal run HelloWorld, cabal run Demonstration and so on. (You will see in rhine/rhine-examples/rhine-examples.cabal which names the examples have)