add 'how to' examples

oktalz · Nov 23, 2024 · 7feefa0 · 7feefa0
1 parent a36de54
commit 7feefa0
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@ go install github.com/oktalz/present@latest
 ## Binaries
   prebuilt binaries can be found on [releases](https://github.com/oktalz/present/releases) page
 
-## Example
+## Running
 
 - enter examples folder, type `present`
   - program should read all files and start web server on port 8080 (default)
@@ -105,3 +105,9 @@ FLAGS
   - [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=ZlatkoBratkovic.vscode-oktalz-present)
 
   - [Open VSX Marketplace](https://open-vsx.org/extension/ZlatkoBratkovic/vscode-oktalz-present)
+
+## Examples
+
+- please see (and run) examples in (examples)[examples] folder
+
+![style](assets/examples/style.png)
diff --git a/assets/examples/style.png b/assets/examples/style.png
diff --git a/doc/README-end.md b/doc/README-end.md
@@ -40,3 +40,9 @@
   - [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=ZlatkoBratkovic.vscode-oktalz-present)
 
   - [Open VSX Marketplace](https://open-vsx.org/extension/ZlatkoBratkovic/vscode-oktalz-present)
+
+## Examples
+
+- please see (and run) examples in (examples)[examples] folder
+
+![style](assets/examples/style.png)
diff --git a/doc/README-start.md b/doc/README-start.md
@@ -24,7 +24,7 @@ go install github.com/oktalz/present@latest
 ## Binaries
   prebuilt binaries can be found on [releases](https://github.com/oktalz/present/releases) page
 
-## Example
+## Running
 
 - enter examples folder, type `present`
   - program should read all files and start web server on port 8080 (default)