Merge pull request #175 from MIERUNE/feat/readme-english

Feat/readme in english
MIERUNE · Sep 10, 2024 · 1309653 · 1309653
2 parents 8e7943b + 42d9a71
commit 1309653
Show file tree

Hide file tree

Showing 3 changed files with 96 additions and 53 deletions.
diff --git a/README.md b/README.md
@@ -2,13 +2,14 @@
 
 
 
-このリポジトリでは、Adobe IllustratorでGISデータを読み込みためのソフトウェア`PlugX-QGIS`向けに、GISデータをエクスポートするためのQGISプラグインを管理します。
+このリポジトリでは、Adobe IllustratorでGISデータを読み込みためのソフトウェア`PlugX-QGIS`向けに、GISデータをエクスポートするためのQGISプラグインを管理します。<br><br>
+This plugin exports GIS data in a folder, which can be read and imported into Adobe Illustrator using an add-on called `PlugX-QGIS`.
 
-## 本プラグインとPlugX-QGISの連携方法について
+## 本プラグインとPlugX-QGISの連携方法について / How to use this plugin with PlugX-QGIS
 
 ```mermaid
 graph LR
-A[GISデータ] --本プラグインで切り出し変換--> B[出力フォルダ] --読み込み--> C[Adobe Illustrator\nwith PlugX]
+A[GISデータ<br/>GIS data] --本プラグインで切り出し変換<br/>clip and export with this plugin--> B[出力フォルダ<br/>export folder] --読み込み<br/>load--> C[Adobe Illustrator<br/>with PlugX]
 
 ```
 ![qgis_ai_screencap](./imgs/qgis_ai_screencap.png)
@@ -18,29 +19,33 @@ https://github.com/MIERUNE/qgis-plugin-for-plugx/assets/26103833/c717b613-8569-4
 
 
 
-## 使い方
+## 使い方 / Usage
 
 ```planetext
 本プラグインで出力した結果を読み込むには、別途「PlugX-QGIS」の導入・インストールが必要です。
-```
-
-1. QGISで本プラグインをインストール
-
-2. エクスポートするQGISプロジェクトを開く
-
-3. プラグインのメイン画面を開く
 
-4. エクスポートしたいレイヤーを選択する・切り出す範囲を選択する
-
-5. 処理を実行する
+To read the results exported by this plugin, the installation of "PlugX-QGIS" into Adobe Illustrator is required.
+```
 
-6. 出力フォルダをPlugX-QGISで読み込む
+|使い方| Usage | 
+|--------------------|-----|
+| 1. QGISで本プラグインをインストール     |1. Install this plugin in QGIS. | 
+| 2. エクスポートするQGISプロジェクトを開く|2. Open the QGIS project you want to export.| 
+| 3. プラグインのメイン画面を開く  | 3. Open the plugin’s main window.| 
+| 4. エクスポートしたいレイヤーを選択する・切り出す範囲を選択する  | 4. Select the layers you want to export and choose the area to crop.| 
+| 5. 処理を実行する |5. Run the process. | 
+| 6. 出力フォルダをPlugX-QGISで読み込む  | 6. Load the output folder in PlugX-QGIS.| 
 
 <!-- PlugXの操作画面 -->
 
-## 備考
+## 備考 / Remarks
 
 - データのサイズによっては処理に時間がかかることがあります。
 - QGIS上の全てのシンボルには対応していません。対応しているシンボル一覧は[こちら](./docs/SYMBOLS.md)を参照してください。
     - 対応していないシンボルは、デフォルトのシンボルに置き換えられるか、読み飛ばされます。
 - もし不具合があれば、[Issues](https://github.com/MIERUNE/qgis-plugin-for-plugx/issues)にて報告していただけると、改善につながります。
+
+- Processing may take time depending on the size of the data.
+- Not all symbols in QGIS are supported. Please check [this list](./docs/SYMBOLS.md) for supported symbols.
+    - Unsupported symbols will be replaced with default ones or ignored.
+- If you encounter any issues, please report them in the [Issues](https://github.com/MIERUNE/qgis-plugin-for-plugx/issues) section to help us improve.
diff --git a/docs/README.md b/docs/README.md
@@ -1,7 +1,8 @@
 # QGIS Plugin for PlugX - Design Documents
 
-## 概要
+## 概要 / Overview
 
+日本語
 - 出力ファイルの形式
   - ベクター：ESRI Shapefile
   - ラスター：PNG
@@ -10,7 +11,16 @@
 - JSONの全ての座標は、プロジェクトCRSの座標である
 - JSONの全てのサイズは、ポイント単位である
 
-## 出力フォルダの構成
+English
+- Output File Formats:
+  - Vector: ESRI Shapefile
+  - Raster: PNG
+- All layers are converted to the project CRS before being exported.
+- Each vector layer is exported for every symbol it contains.
+- All coordinates in the exported JSON files are in the project CRS.
+- All sizes in the exported JSON files are in points.
+
+## 出力フォルダの構成 / Output folder structure
 
 ```planetext
 .
@@ -19,11 +29,11 @@
 │   ├── someicon.svg
 │   ├── somepic.png
 │   ├── someanimation.gif
-├── layer_0_0.shp # layer_n_mという命名規則: n=レイヤーの順序、m=シンボルの順序。辞書順で降順＝数字が大きいほど手前。mは省略可能。
+├── layer_0_0.shp *1
 ├── layer_0_0.json
-├── layer_0_1.shp # ベクターレイヤーの場合、シンボルの数だけ出力される
+├── layer_0_1.shp *2
 ├── layer_0_1.json
-├── layer_2.shp # データが空のレイヤーはスキップされる（必ずしも連番ではない）
+├── layer_2.shp *3
 ├── layer_2.json
 ├── layer_5.png
 ├── layer_5.json
@@ -34,6 +44,20 @@
 └── label_n.json
 ```
 
+*1: 
+- layer_n_mという命名規則: n=レイヤーの順序、m=シンボルの順序。辞書順で降順＝数字が大きいほど手前。mは省略可能。
+- naming convention: layer_n_m, where n is the layer order and m is the symbol order. Sorted in descending order (higher numbers appear in front). m can be omitted.
+
+*2: 
+- ベクターレイヤーの場合、シンボルの数だけ出力される.
+- *2: For vector layers, the output is generated for each symbol.
+
+*3: 
+- データが空のレイヤーはスキップされる（必ずしも連番ではない）
+- Layers with no data are skipped (not necessarily sequential numbers).
+
+
+
 ### project.json
 
 ```json
@@ -49,7 +73,7 @@
   ],
   "scale": 23031.837306501773,
   "layers": [
-    "layer_0", // 出力されたレイヤー一覧: layer_n_mに対応する
+    "layer_0", // 出力されたレイヤー一覧: layer_n_mに対応する. List of exported layers corresponds to: layer_n_m.
     "layer_2",
     "layer_5",
     "layer_n"
@@ -95,6 +119,7 @@
   "blend_mode": "normal", // normal | lighten | screen | dogde | addition | darken | multiply | burn | overlay | soft_light | hard_light | difference | subtract
   "symbols": [
       // symbol typeに応じた辞書からなる配列。別ページにて仕様を定義
+      // Array of dictionaries corresponding to the symbol type. Specifications are defined on a separate page.
       {
           "type": "svg",
           "width": 10,
@@ -112,7 +137,7 @@
       }
   ],
   "usingSymbolLevels": true,
-  "legend": "1 - 20000", // 凡例名 (categoricalかグラデーションの場合のみ)
+  "legend": "1 - 20000", // 凡例名 (categoricalかグラデーションの場合のみ). Legend name (only for categorical or gradient symbolization)
 }
 ```