update docs

HapticX · Dec 12, 2023 · eefc287 · eefc287
1 parent f89eb7c
commit eefc287
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/src/happyx_native/app/app.nim b/src/happyx_native/app/app.nim
@@ -70,6 +70,17 @@ template nativeApp*(appDirectory: string = "/assets", port: int = 5000,
                     appMode: bool = true, title: string = "",
                     resizeable: bool = true, establish: bool = true
 ) {.dirty.} =
+  ## Compiles main happyx file, opens browser in `appMode` and
+  ## starts serving at localhost with `port
+  ## 
+  ## Your project should have this structure:
+  ## 
+  ## ```
+  ## assets/
+  ## ├─ index.html
+  ## ├─ main.nim
+  ## app.nim
+  ## ```
   # Compile main
   discard execCmdEx(
     "nim js -d:danger --opt:size " & getCurrentDir() / appDirectory & "/main.nim"