Added tip to examples

Anton-4 · web-flow · commit 75c5dc306206 · 2025-01-01T18:30:18.000+01:00
diff --git a/examples/args.roc b/examples/args.roc
@@ -2,6 +2,8 @@ app [main!] {
     pf: platform "../platform/main.roc",
 }
 
+# To run this example: check the README.md in this folder
+
 import pf.Stdout
 import pf.Arg exposing [Arg]
 
diff --git a/examples/command.roc b/examples/command.roc
@@ -1,5 +1,7 @@
 app [main!] { pf: platform "../platform/main.roc" }
 
+# To run this example: check the README.md in this folder
+
 import pf.Stdout
 import pf.Cmd
 
diff --git a/examples/countdown.roc b/examples/countdown.roc
@@ -1,5 +1,7 @@
 app [main!] { pf: platform "../platform/main.roc" }
 
+# To run this example: check the README.md in this folder
+
 import pf.Stdin
 import pf.Stdout
 
diff --git a/examples/dir.roc b/examples/dir.roc
@@ -1,5 +1,7 @@
 app [main!] { pf: platform "../platform/main.roc" }
 
+# To run this example: check the README.md in this folder
+
 import pf.Stdout
 import pf.Dir
 import pf.Path
diff --git a/examples/echo.roc b/examples/echo.roc
@@ -1,5 +1,7 @@
 app [main!] { pf: platform "../platform/main.roc" }
 
+# To run this example: check the README.md in this folder
+
 import pf.Stdin
 import pf.Stdout
 
diff --git a/examples/env-var.roc b/examples/env-var.roc
@@ -1,5 +1,7 @@
 app [main!] { pf: platform "../platform/main.roc" }
 
+# To run this example: check the README.md in this folder
+
 import pf.Stdout
 import pf.Env
 
diff --git a/examples/file-mixed.roc b/examples/file-mixed.roc
@@ -1,5 +1,7 @@
 app [main!] { pf: platform "../platform/main.roc" }
 
+# To run this example: check the README.md in this folder
+
 import pf.Stdout
 import pf.Stderr
 import pf.File
diff --git a/examples/file-read-buffered.roc b/examples/file-read-buffered.roc
@@ -1,5 +1,7 @@
 app [main!] { pf: platform "../platform/main.roc" }
 
+# To run this example: check the README.md in this folder
+
 import pf.Stdout
 import pf.File
 
diff --git a/examples/file-read.roc b/examples/file-read.roc
@@ -1,5 +1,7 @@
 app [main!] { pf: platform "../platform/main.roc" }
 
+# To run this example: check the README.md in this folder
+
 import pf.Stdout
 import pf.File
 
diff --git a/examples/form.roc b/examples/form.roc
@@ -1,5 +1,7 @@
 app [main!] { pf: platform "../platform/main.roc" }
 
+# To run this example: check the README.md in this folder
+
 import pf.Stdin
 import pf.Stdout
 
diff --git a/examples/hello-world.roc b/examples/hello-world.roc
@@ -1,5 +1,7 @@
 app [main!] { pf: platform "../platform/main.roc" }
 
+# To run this example: check the README.md in this folder
+
 import pf.Stdout
 
 main! = \_args ->
diff --git a/examples/http-get-json.roc b/examples/http-get-json.roc
@@ -3,6 +3,8 @@ app [main!] {
     json: "https://github.com/lukewilliamboswell/roc-json/releases/download/0.11.0/z45Wzc-J39TLNweQUoLw3IGZtkQiEN3lTBv3BXErRjQ.tar.br",
 }
 
+# To run this example: check the README.md in this folder
+
 import pf.Http
 import pf.Stdout
 import json.Json
diff --git a/examples/http-get.roc b/examples/http-get.roc
@@ -4,6 +4,7 @@ import pf.Http
 import pf.Stdout
 
 # Basic HTTP GET request
+# To run this example: check the README.md in this folder
 
 main! = \_args ->
 
diff --git a/examples/path.roc b/examples/path.roc
@@ -3,6 +3,8 @@ app [main!] { pf: platform "../platform/main.roc" }
 import pf.Stdout
 import pf.Path
 
+# To run this example: check the README.md in this folder
+
 main! = \_args ->
 
     path = Path.from_str "path.roc"
diff --git a/examples/piping.roc b/examples/piping.roc
@@ -3,6 +3,8 @@ app [main!] { pf: platform "../platform/main.roc" }
 import pf.Stdout
 import pf.Stdin
 
+# To run this example: check the README.md in this folder
+
 # Try piping in some text like this: `echo -e "test\n123" | roc piping.roc`
 main! = \_args ->
     lines = count! 0
diff --git a/examples/record-builder.roc b/examples/record-builder.roc
@@ -4,6 +4,8 @@ app [main!] {
 
 import pf.Stdout
 
+# To run this example: check the README.md in this folder
+
 main! = \_args ->
     { apples, oranges } = try
         { Result.map2 <-
diff --git a/examples/result.roc b/examples/result.roc
@@ -2,6 +2,8 @@ app [main!] { pf: platform "../platform/main.roc" }
 
 import pf.Stdout
 
+# To run this example: check the README.md in this folder
+
 main! = \_args ->
     when check_file! "good" is
         Ok Good -> Stdout.line! "GOOD"
diff --git a/examples/sqlite.roc b/examples/sqlite.roc
@@ -4,6 +4,8 @@ import pf.Env
 import pf.Stdout
 import pf.Sqlite
 
+# To run this example: check the README.md in this folder
+
 main! = \_args ->
     db_path = try Env.var! "DB_PATH"
 
diff --git a/examples/stdin.roc b/examples/stdin.roc
@@ -4,6 +4,8 @@ import pf.Stdout
 import pf.Stderr
 import pf.Stdin
 
+# To run this example: check the README.md in this folder
+
 main! = \_args ->
     try Stdout.line! "Enter a series of number characters (0-9):"
 
diff --git a/examples/task-list.roc b/examples/task-list.roc
@@ -2,6 +2,8 @@ app [main!] { pf: platform "../platform/main.roc" }
 
 import pf.Stdout
 
+# To run this example: check the README.md in this folder
+
 main! = \_args ->
     # Prints out each of the authors
     print! ["Foo", "Bar", "Baz"]
diff --git a/examples/tcp-client.roc b/examples/tcp-client.roc
@@ -5,6 +5,8 @@ import pf.Stdout
 import pf.Stdin
 import pf.Stderr
 
+# To run this example: check the README.md in this folder
+
 main! = \_args ->
     when run! {} is
         Ok {} -> Ok {}
diff --git a/examples/temp-dir.roc b/examples/temp-dir.roc
@@ -4,6 +4,8 @@ import pf.Stdout
 import pf.Env
 import pf.Path
 
+# To run this example: check the README.md in this folder
+
 ## Prints the default temp dir
 ##
 ## !! requires --linker=legacy
diff --git a/examples/time.roc b/examples/time.roc
@@ -4,6 +4,8 @@ import pf.Stdout
 import pf.Utc
 import pf.Sleep
 
+# To run this example: check the README.md in this folder
+
 main! = \_args ->
     start = Utc.now! {}
 

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,8 @@ app [main!] {`
`2`	`2`	`pf: platform "../platform/main.roc",`
`3`	`3`	`}`
`4`	`4`
	`5`	`+# To run this example: check the README.md in this folder`
	`6`	`+`
`5`	`7`	`import pf.Stdout`
`6`	`8`	`import pf.Arg exposing [Arg]`
`7`	`9`