update readme

CaseyNelson314 · Dec 22, 2023 · 225985c · 225985c
1 parent 4097b5b
commit 225985c
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 713 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,27 @@
 # EFSim
-電界シミュレータ
+
+[![GitHub Pages Deploy](https://github.com/CaseyNelson314/EFSim/actions/workflows/deploy.yml/badge.svg)](https://github.com/CaseyNelson314/EFSim/actions/workflows/deploy.yml)
+
+Electric Field Simulator
+
+## Local Execute
+
+### setup
+
+Install NodeJS
+
+```sh
+winget install -e --id OpenJS.NodeJS
+```
+
+Install node modules
+
+```sh
+npm install --save-dev
+```
+
+### launch local server
+
+```
+npm dev
+```