docusaurus: plutus exe #6743
docusaurus: plutus exe #6743
Conversation
bezirg
had a problem deploying
to
github-pages
GitHub Actions
Failure
|
|
||
| # Running and Debugging Compiled Code | ||
|
|
||
| You can run compiled code locally (without the need of a Cardano Node) |
There was a problem hiding this comment.
I think the for most people, the most useful functionality of the executable is optimizing UPLC. This should be made clear at the beginning. Debugging, on the other hand, should be de-emphasized, since we don't really have a working debugger.
The initial examples should also focus on how to use it for UPLC optimization, before talking about anything else.
| In the following example we check a program written in the PIR (Plutus Intermediate Representation) language: | ||
|
|
||
| ``` shell | ||
| $ echo "(program 1.1.0 (lam x (con integer) (lam y (con integer) x)))" > const.pir |
There was a problem hiding this comment.
For each thing the executable can do (compiling, checking etc.), the first examples should be UPLC (unless the thing doesn't apply to UPLC). TPLC and PIR examples are optional, and if you prefer to include them, they should come after the UPLC examples.
|
|
||
| ``` shell | ||
| $ echo "(program 1.1.0 (lam x (con integer) (lam y (con integer) x)))" > const.pir | ||
| $ plutus const.pir |
There was a problem hiding this comment.
So if you run plutus without any flag, it performs static checks? That's a weird default, and isn't clear from the help message.
bezirg
had a problem deploying
to
github-pages
GitHub Actions
Failure
| @@ -13,7 +13,7 @@ is hosted on the [Releases] page. Alternatively, you can build the tool specific | |||
| for your platform using Nix: | |||
|
|
|||
| ``` shell | |||
| nix build FIXME | |||
| $ nix build .#cabalProject.x86_64-linux.hsPkgs.plutus-core.components.exes.plutus | |||
There was a problem hiding this comment.
I'd wrap it in double-quotes just in case there are readers with zsh shell... (# is a beginning of comment there)
There was a problem hiding this comment.
It seems to work fine from here. I just installed zsh and fired this command and it works? 🤷♂️
bezirg
had a problem deploying
to
github-pages
GitHub Actions
Failure
bezirg
had a problem deploying
to
github-pages
GitHub Actions
Failure
bezirg
force-pushed
the
bezirg/plutus-exe-doc
branch
from
182449b to
e38502d
Compare
bezirg
had a problem deploying
to
github-pages
GitHub Actions
Failure
| using Nix, specifically for your platform: | ||
|
|
||
| ``` shell | ||
| $ nix build .#cabalProject.$(nix eval nixpkgs#stdenv.buildPlatform.system).hsPkgs.plutus-core.components.exes.plutus |
There was a problem hiding this comment.
- Without the
$I can copy-paste this line easier. - With double quotes around the argument I am protected from
zshmis-interpreting it as a comment.
| $ nix build .#cabalProject.$(nix eval nixpkgs#stdenv.buildPlatform.system).hsPkgs.plutus-core.components.exes.plutus | |
| nix build ".#cabalProject.$(nix eval nixpkgs#stdenv.buildPlatform.system).hsPkgs.plutus-core.components.exes.plutus" |
There was a problem hiding this comment.
I suspect that without the shell specifier this fenced code block will also have the "Copy To Clipboard" button.
Pre-submit checklist: