chshersh / iris

🌈 Haskell CLI Framework supporting Command Line Interface Guidelines
https://hackage.haskell.org/package/iris
Mozilla Public License 2.0
177 stars 22 forks source link

Write usage example using Literate Haskell #16

Closed chshersh closed 1 year ago

chshersh commented 2 years ago

We would like to have tutorial-like examples in Iris, showcasing project features.

The proposed structure of the example:

  1. Rename app directory to examples
  2. Create a separate directory with an example name for each separate example.
  3. Each example also should have a corresponding executable stanza in the iris.cabal file.
  4. Current example should have name playground
  5. Each example (except playground) should be written using markdown-unlit. The structure of an example:
    • README.md with the example content
    • Main.lhs as a symbolic link to the README

Possible examples:

This should be enough for the start but later we can add more examples 🙂

Dponya commented 1 year ago

I'll work on this

chshersh commented 1 year ago

@Dponya Go for it! 👏🏻