Skip to content

present: document shebang and txtar for .play #588

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+18 −0
Open

present: document shebang and txtar for .play #588

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions present/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,24 @@ on the displayed source so the program can be run from the browser.
Although only the selected text is shown, all the source is included
in the HTML output so it can be presented to the compiler.

By default, "play" compiles and executes Go code. But it is also
possible to execute generic scripts if they start with a shebang.

When the Go code imports packages, they are expected to be present in
the GOPATH.

However, Go modules are also possible for each "play" instruction if the
input is txtar-encoded. See

https://pkg.go.dev/golang.org/x/tools/txtar

for a format description. The txtar input must contain a valid go.mod
and go.sum file. A minimal Go module project of main.go, go.mod and
go.sum can be txtar'ed like the following in a POSIX Shell:

$ cp main.go demo.txtar
$ for f in go.{mod,sum}; do echo "-- $f --"; cat "$f"; done >> demo.txtar

link:

Create a hyperlink. The syntax is 1 or 2 space-separated arguments.
Expand Down