roc-lang/roc
1
1
Fork 0
mirror of https://github.com/roc-lang/roc.git synced 2024-11-10 10:02:38 +03:00
Code Issues Packages Projects Releases Wiki Activity

Link to the CLI platform docs in examples README

Browse Source
This commit is contained in:
Richard Feldman 2022-09-03 21:11:21 -04:00
parent 1505cb514e
commit 15f349fc37
No known key found for this signature in database
GPG Key ID: F1F21AA5B1D9E43B
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
examples/interactive/README.md
View File

@ -1,9 +1,11 @@
# Interactive examples
These are examples of how to make extremely basic
CLI (command-line interface) and TUI (terminal user interface) apps in Roc.
These are examples of how to make basic CLI (command-line interface) and TUI (terminal user interface) apps in Roc.
There's not currently much documentation for the CLI platform (which also doesn't support many operations at this point!)
but you can look at [the modules it includes](cli-platform) - for example,
multiple other modules use the [`Task`](cli-platform/Task.roc) module, including the
[`Stdin`](cli-platform/Stdin.roc) and [`Stdout`](cli-platform/Stdout.roc) modules.
The platform is a work in progress, but you can look at [the docs for its modules](https://www.roc-lang.org/examples/cli/Http),
and [its source code](cli-platform) if you'd like to build your own CLI apps, perhaps using
the examples in this directory as starting points!
Feel free to ask [on Zulip](https://roc.zulipchat.com) in the `#beginners` channel if you have questions about making
CLI apps, or if there are operations you'd like to see added to this example CLI platform (for
an application you'd like to build in Roc).