Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write usage example using Literate Haskell #16

Closed
2 tasks done
chshersh opened this issue May 21, 2022 · 2 comments · Fixed by #87
Closed
2 tasks done

Write usage example using Literate Haskell #16

chshersh opened this issue May 21, 2022 · 2 comments · Fixed by #87
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest https://hacktoberfest.com/

Comments

@chshersh
Copy link
Owner

chshersh commented May 21, 2022

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:

  • playground
  • Simple grep: search lines containing substring in a given file, print coloured file name to stderr, lines numbers to stderr and with lines to stdout (to mimic the output of ripgrep)

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

@chshersh chshersh added the documentation Improvements or additions to documentation label May 21, 2022
@chshersh chshersh added this to the v0.0.0.0: Big launch milestone May 21, 2022
@chshersh chshersh moved this to Todo in Iris Project May 21, 2022
@chshersh chshersh moved this from Todo to In Progress in Iris Project Jun 13, 2022
@chshersh chshersh moved this from In Progress to Todo in Iris Project Jun 13, 2022
@chshersh chshersh removed this from the v0.0.0.0: Initial Launch milestone Jun 25, 2022
@chshersh chshersh added the good first issue Good for newcomers label Aug 8, 2022
@chshersh chshersh added this to the v0.1.0.0: Improved UX milestone Sep 2, 2022
@chshersh chshersh pinned this issue Sep 2, 2022
@chshersh chshersh added the hacktoberfest https://hacktoberfest.com/ label Sep 27, 2022
@Dponya
Copy link
Contributor

Dponya commented Oct 6, 2022

I'll work on this

@chshersh
Copy link
Owner Author

chshersh commented Oct 6, 2022

@Dponya Go for it! 👏🏻

chshersh pushed a commit that referenced this issue Oct 14, 2022
Resolves #16 

* add simple-grep example. rename app & example to playground
* update README.md && fix markdown-unlit conf
* fix grammar problems & section and example function
Repository owner moved this from Todo to Done in Iris Project Oct 14, 2022
@chshersh chshersh unpinned this issue Nov 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest https://hacktoberfest.com/
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants