documentation

README.md

@@ -2,23 +2,31 @@
 
 使用 React + Next.js + MUI 编写的地铁图程序。包括完整的北京地铁数据。只有中文语言支持。
 
+同时，支持 Android / Electron Build
+
 A subway map web utility written with React + Next.js + MUI. Full beijing subway data included. 
 
+Also supports Android / Electron platforms.
+
 [🔗 Try it now!*](https://beijingsubwaymap.vercel.app/)
 
-\* Visitors from specific regions may experience issue accessing this. 
+\* Visitors from specific regions may experience issue accessing this. If you have trouble, use this link:
+
+[🔗 Try it now!*](https://smallg0at.github.io/subwaymapv2/)
+
 
 ## Features
 
 - Very friendly UI
 - Dark mode
 - Three pathfinding options: Shortest, Fastest, Least Transfers
 - Travel Ticket option - sort of? Implemented cruelly.
+- Mobile-friendly
 
 ## Init
 
 ```bash
-npm install
+npm i
 ```
 
 ## Testing
@@ -31,7 +39,7 @@ npm run dev
 
 Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
 
-## Building
+## Building (Web)
 
 Make sure the dev server is closed before building.
 
@@ -40,6 +48,44 @@ npm run build
 npm start
 ```
 
+## Building (Android)
+
+### Requirements
+
+Android Studio + Android SDK 33
+
+
+### Usage
+
+```bash
+npm run build
+npx cap sync
+```
+
+Then launch Android Studio with:
+
+```
+npx cap open android
+```
+
+## Building (Electron)
+
+### Setup
+
+This will take a whild
+
+```
+cd ./electron/
+npm i
+```
+
+### Building
+
+```
+cd ./electron/
+npm run electron:make
+```
+
 ## Data Structure
 
 All data is stored in `src/app/data`.
@@ -67,7 +113,7 @@ This project uses a modified MIT License with the following limitation:
 
 For performance analytics reasons, this app will send anonymous data to vercel's server to help the author to do some optimization. 
 
-## About
+## About0
 
 This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
 

electron/package.json

@@ -3,12 +3,12 @@
   "version": "1.0.0",
   "description": "An Amazing Capacitor App",
   "author": {
-    "name": "",
-    "email": ""
+    "name": "Jerry Liu",
+    "email": "smallg0at@outlook.com"
   },
   "repository": {
     "type": "git",
-    "url": ""
+    "url": "https://github.com/smallg0at/subwaymapv2.git"
   },
   "license": "MIT",
   "main": "build/src/index.js",
@@ -17,7 +17,7 @@
     "electron:start-live": "node ./live-runner.js",
     "electron:start": "npm run build && electron --inspect=5858 ./",
     "electron:pack": "npm run build && electron-builder build --dir -c ./electron-builder.config.json",
-    "electron:make": "npm run build && electron-builder build -c ./electron-builder.config.json -p always"
+    "electron:make": "npm run build && electron-builder build -c ./electron-builder.config.json -p always --publish=never"
   },
   "dependencies": {
     "@capacitor-community/electron": "^5.0.0",