[documentation] simulator

24ik · Oct 30, 2024 · d1fc17e · d1fc17e
1 parent 6f078d1
commit d1fc17e
Show file tree

Hide file tree

Showing 8 changed files with 179 additions and 11 deletions.
diff --git a/.gitignore b/.gitignore
@@ -10,6 +10,7 @@
 /src/htmldocs/
 
 /www/assets/
+/www/docs/simulator/index.min.js
 /www/docs/native/
 /www/docs/web/
 /www/marathon/index.min.js

diff --git a/README.md b/README.md
@@ -40,8 +40,16 @@ nimble install pon2 -p:-d:danger -p:-d:pon2.avx2=<bool> -p:-d:pon2.bmi2=<bool>
 
 ## Usage
 
+### CLI or Native Application
+
 Run `pon2 -h`.
 
+### Web Application
+
+See the documentations:
+
+- [Simulator](https://24ik.github.io/pon2/docs/simulator/)
+
 ## For Developers
 
 It is necessary to place the `assets` directory to the one specified by

diff --git a/pon2.nimble b/pon2.nimble
@@ -1,6 +1,6 @@
 # Package
 
-version = "0.23.8"
+version = "0.23.9"
 author = "Keisuke Izumiya"
 description = "Application for Puyo Puyo and Nazo Puyo"
 license = "Apache-2.0"
@@ -16,7 +16,7 @@ requires "nim ^= 2.2.0"
 requires "docopt ^= 0.7.1"
 requires "karax ^= 1.3.3"
 requires "nigui ^= 0.2.8"
-requires "nimsimd ^= 1.2.13"
+requires "nimsimd ^= 1.3.0"
 requires "puppy ^= 2.1.2"
 requires "suru ^= 0.3.2"
 
@@ -39,13 +39,6 @@ task benchmark, "Benchmarking":
 
   exec &"nim c -r -d:pon2.avx2={Avx2} -d:pon2.bmi2={Bmi2} " & "benchmark/main.nim"
 
-task documentation, "Make Documentation":
-  rmDir "www/docs/native"
-  exec &"nim doc --project --outdir:www/docs/native src/pon2.nim"
-
-  rmDir "www/docs/web"
-  exec &"nim doc --project --outdir:www/docs/web --backend:js src/pon2.nim"
-
 task web, "Make Web Pages":
   const
     danger {.booldefine.} = true
@@ -85,7 +78,11 @@ task web, "Make Web Pages":
   "src/pon2.nim".compile "www/marathon/index.min.js", "-d:pon2.marathon", "-d:pon2.assets.web=../assets"
 
   # documentation
-  exec "nimble -y documentation"
+  rmDir "www/docs/native"
+  exec &"nim doc --project --outdir:www/docs/native src/pon2.nim"
+  rmDir "www/docs/web"
+  exec &"nim doc --project --outdir:www/docs/web --backend:js src/pon2.nim"
+  "www/docs/simulator/main.nim".compile "www/docs/simulator/index.min.js"
 
   # assets
   cpDir "assets", "www/assets"
diff --git a/www/docs/index.html b/www/docs/index.html
@@ -3,7 +3,7 @@
     <head>
         <meta charset="UTF-8" />
         <meta name="viewport" content="width=device-width, initial-scale=1" />
-        <title>Pon! Tsu API Document</title>
+        <title>Pon! Tsu | API Document</title>
         <link
             href="https://cdn.jsdelivr.net/npm/bulma@1.0.2/css/bulma.min.css"
             rel="stylesheet"

diff --git a/www/docs/simulator/index.html b/www/docs/simulator/index.html
@@ -0,0 +1,22 @@
+<!doctype html>
+<html lang="ja">
+    <head>
+        <meta charset="UTF-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1" />
+        <title>Pon!通 | 操作方法</title>
+        <link
+            href="https://cdn.jsdelivr.net/npm/bulma@1.0.2/css/bulma.min.css"
+            rel="stylesheet"
+        />
+        <link
+            href="../../favicon.ico"
+            rel="shortcut icon"
+            type="image/x-icon"
+        />
+    </head>
+
+    <body>
+        <div id="ROOT"></div>
+        <script src="./index.min.js"></script>
+    </body>
+</html>
diff --git a/www/docs/simulator/main.nim b/www/docs/simulator/main.nim
@@ -0,0 +1,18 @@
+{.experimental: "inferGenericTypes".}
+{.experimental: "notnil".}
+{.experimental: "strictCaseObjects".}
+{.experimental: "strictDefs".}
+{.experimental: "strictFuncs".}
+{.experimental: "views".}
+
+import karax/[karax, karaxdsl, vdom]
+
+proc newMainNode(): VNode =
+  buildHtml(section(class = "section")):
+    tdiv(class = "content"):
+      h1(class = "title"):
+        text "Pon!通 操作方法"
+      img(src = "./manual.png", width = "800")
+
+when isMainModule:
+  setRenderer newMainNode
diff --git a/www/docs/simulator/manual.drawio b/www/docs/simulator/manual.drawio
diff --git a/www/docs/simulator/manual.png b/www/docs/simulator/manual.png