Skip to content

Commit

Permalink
add more info to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
oktalz committed Dec 3, 2024
1 parent 0384e3f commit a417b79
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 4 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ tool for viewing presentations written in markdown like format
slides are written in text friendly format and follow all standard
markdown rules with some additions

main purpose of application is to view presentation in browsers
main purpose of application is:
- view presentation in browsers
- have option to run code directly from presentation
- support for any language, no sandbox, "run on your machine principle"

## Installation
Use the following command to download and install this tool:
Expand Down
5 changes: 4 additions & 1 deletion doc/README-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ tool for viewing presentations written in markdown like format
slides are written in text friendly format and follow all standard
markdown rules with some additions

main purpose of application is to view presentation in browsers
main purpose of application is:
- view presentation in browsers
- have option to run code directly from presentation
- support for any language, no sandbox, "run on your machine principle"

## Installation
Use the following command to download and install this tool:
Expand Down
2 changes: 1 addition & 1 deletion examples/code/.slide
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
.template.end

.template{CAST}
.cast.stream.edit.save(mai1n.go).run(go run .).before(go mod init x)
.cast.stream.edit.save(main.go).run(go run .).before(go mod init x)
.template.end

.template{CAST_SHOW}(From,To)
Expand Down
2 changes: 1 addition & 1 deletion examples/code/1.code.slide
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ any kind of terminal command can be executed

- command to execute specific command in specified folder and return result

.cast.path(hello-world).run(go run .)
.cast.path(hello-world).run(go run .).before(go mod init)
```txt
#dot#cast.path(hello-world).run(go run .)
```
Expand Down

0 comments on commit a417b79

Please sign in to comment.