basic-cli docs --> roc-lang.org/packages/basic-cli

This commit is contained in:
Richard Feldman 2022-11-26 17:53:51 -05:00
parent d3f39400b6
commit 956d3d1462
No known key found for this signature in database
GPG Key ID: F1F21AA5B1D9E43B
3 changed files with 5 additions and 2 deletions

View File

@ -2,7 +2,7 @@
These are examples of how to make basic CLI (command-line interface) and TUI (terminal user interface) apps in Roc.
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),
The [`basic-cli` platform](https://github.com/roc-lang/basic-cli) is a work in progress, but you can look at [the docs for its modules](https://www.roc-lang.org/packages/basic-cli/Http),
and [its source code](https://github.com/roc-lang/basic-cli) if you'd like to build your own CLI apps, perhaps using
the examples in this directory as starting points!

View File

@ -69,6 +69,6 @@ rm -rf ./downloaded-basic-cli
mkdir www/build/examples
rm generated-docs/*.* # we already copied over the *.js and *.css files earlier, so just drop these.
mv generated-docs/ www/build/examples/cli # move all the folders to build/examples/cli
mv generated-docs/ www/build/packages/basic-cli # move all the folders to build/packages/basic-cli
popd

View File

@ -1278,6 +1278,9 @@ module comes from the package we named <code>pf</code> in the <code>packages { p
<p>If we would like to include other modules in our application, say <code>AdditionalModule.roc</code> and <code>AnotherModule.roc</code>, then they can be imported directly in <code>imports</code> like this: </p>
<samp><span class="kw">imports</span> <span class="brace">[</span>pf.Stdout<span class="comma">,</span> AdditionalModule<span class="comma">,</span> AnotherModule<span class="brace">]</span></span>
</samp>
<p>You can find the <a href="https://www.roc-lang.org/packages/basic-cli/Stdout#line">documentation for <code>Stdout.line</code></a>
in <a href="https://www.roc-lang.org/packages/basic-cli/Stdout">the documentation for the <code>Stdout</code> module</a>.
</p>
<h2 id="tasks"><a href="#tasks">Tasks</a></h2>
<p>Tasks are technically not part of the Roc language, but they're very common in
platforms. Let's continue using the <a href="https://github.com/roc-lang/basic-cli">basic-cli</a> platform