From 58e22b7c85d03a491f5f0fa7409f47ea2b0416bf Mon Sep 17 00:00:00 2001
From: Halyul <i@halyul.dev>
Date: Tue, 1 Jun 2021 17:05:12 -0400
Subject: [PATCH] docs(readme): update README.md

---
 README.md   | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 aklive2d.py | 19 ++++++++--------
 2 files changed, 72 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 06b20a5..5881326 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,67 @@
 # aklive2d
 
+A project that builds showcase webpage for Arknights Live2D-equipped operators. Showcase webpage can be used as a wallpaper for Wallpaper Engine.
+
+## Supported Operators
+
+| Operator | Live Preview | Steam Workshop |
+|----------|--------------|----------------|
+| Skadi the Corrupting Heart | [Link](https://arknights.halyul.dev/skadi/) | [Link](https://steamcommunity.com/sharedfiles/filedetails/?id=2492307783) |
+
+## Usage
+
+``` bash
+$ python3 aklive2d.py -h  
+usage: aklive2d [-h] {server,s,build,b} ...
+
+Arknights Live 2D Wallpaper Builder
+
+optional arguments:
+  -h, --help          show this help message and exit
+
+Available commands:
+  {server,s,build,b}  <Required> Select the command to run
+    server (s)        Development Server
+    build (b)         Build releases
+```
+``` bash
+$ python3 aklive2d.py s -h
+usage: aklive2d server [-h] [-p PORT] -o {skadi}
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -p PORT, --port PORT  Development server port (default: 8080)
+  -o {skadi}, --operator {skadi}
+                        <Required> Operatro to develop (default: None)
+```
+``` bash
+$ python aklive2d.py b -h
+usage: aklive2d build [-h] [-o {all,skadi} [{all,skadi} ...]]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -o {all,skadi} [{all,skadi} ...], --operators {all,skadi} [{all,skadi} ...]
+                        Operators to build (default: ['all'])
+```
+## Config
+``` yaml
+# List all the supported operators under <operators> block
+operators:
+  # Single operator block
+  skadi: # <operator name>/<folder name under "operator" folder>, will be used to replace <{name}>
+    common_name: dyn_illust_char_1012_skadi2 # common file name
+    preview: preview.jpg # Steam workshop preview image file
+    project_json: project.json # Steam workshop project file
+    release_folder: ./release/{name}/ # The folder that stores game files for the showcase webpage
+    source_folder: ./operator/{name}/extracted/ # The folder that stores extracted game files
+    target_folder: ./operator/{name}/ # The folder that stores processed game files
+    use_skel: true # For the Spine model, <true> for using skel file, otherwise use json
+# Development server settings
+server:
+  operator_folder: /operator/ # The path that the showcase webpage accesses game files
+  release_folder: ./release/ # The folder that stores the showcase webpage
+  template_folder: /template/ # The folder that stores the showcase template
+```
 ## LICENSE
 
 The `LICENSE` file applies to all files unless listed specifically.
diff --git a/aklive2d.py b/aklive2d.py
index f37a8aa..09046da 100644
--- a/aklive2d.py
+++ b/aklive2d.py
@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 import argparse
 import sys
 
@@ -18,13 +19,13 @@ class AkLive2D:
             description="Arknights Live 2D Wallpaper Builder", 
             formatter_class=argparse.ArgumentDefaultsHelpFormatter
         )
-        parser.add_argument(
-            "-d", 
-            "--debug", 
-            dest="debug", 
-            action="store_true", 
-            help="To debug the app"
-        )
+        # parser.add_argument(
+        #     "-d", 
+        #     "--debug", 
+        #     dest="debug", 
+        #     action="store_true", 
+        #     help="To debug the app"
+        # )
 
         subprasers = parser.add_subparsers(
             title="Available commands", 
@@ -65,12 +66,12 @@ class AkLive2D:
         )
         build.add_argument(
             "-o", 
-            "--operator", 
+            "--operators", 
             dest="operator_names", 
             type=str, 
             default=["all"], 
             nargs='+', 
-            help="Operatro to build", 
+            help="Operators to build", 
             choices=["all"] + [key for key in self.config["operators"]]
         )