Update: documents

nutti · Nov 29, 2017 · bfea53d · bfea53d
1 parent 8329863
commit bfea53d
Show file tree

Hide file tree

Showing 4 changed files with 125 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -17,8 +17,12 @@ You can install/uninstall/update all add-on's released on GitHub with this appli
 
 ## Support Languages
 
-**English** only.
+The list of languages supported by this application is shown below.
+If you want to support other languages, please send me translated strings.
 
+* English (Default)
+* Spanish
+  * Contributed by @Oxer
 
 ## Features
 
@@ -29,6 +33,8 @@ This application has features as follows.
   * Install add-on released on GitHub
   * Uninstall add-on which is already installed (only **External** support level)
   * Update add-on released on GitHub
+  * Favorite
+* Migrate add-ons among different Blender version
 
 
 ## Tutorials
@@ -48,9 +54,10 @@ See the link below for further details.
 
 |Version|Release Date|Change Log|
 |---|---|---|
-|1.0|2017.11.9|[1] Manage Custom Add-on Folder<br>[2] Ignore List<br>[3] Sorting Option in Add-on List<br>[4] Delete Add-on whose link is already broken automatically (server).<br>[5] Fix bug<br> - Failed to detect add-ons whose path contains "."|
-|0.3|2017.4.11|[1] Move config/DB file to user directory<br>[2] Improve server's stability<br>[3] Error popup<br>[4] Fix bug<br> - Failed to run application developed by unidentified developer on macOS<br> - Failed to load add-on at Blender installed by this application|
-|0.2|2017.4.2|[1] Support macOS<br>[2] Add features<br> - Link button to Add-on repository<br> - Case-insensitive search<br>[3]Fix bug<br> - Failed to install when ```__init__.py``` is located on the top directory|
+|1.1|2017.XX.X|[1] Add features<br> - Favorite<br> - Migrate Add-on among different Blender version<br>[2] Support Language<br> - Spanish<br>[3] Add scroll bar<br>[4] Update Add-on Database API (server)<br>[5] Improve deletion algorithm on the add-on DB cleaner (server)|
+|1.0|2017.11.9|[1] Add features<br> - Manage Custom Add-on Folder<br> - Ignore List<br>[2] Add Sorting Option in Add-on List<br>[3] Delete Add-on whose link is already broken automatically (server)<br>[4] Fix bug<br> - Failed to detect add-ons whose path contains "."|
+|0.3|2017.4.11|[1] Move config/DB file to user directory<br>[2] Improve server's stability<br>[3] Error popup<br>[4] Fix bug<br> - Failed to run application developed by unidentified developer on macOS<br> - Failed to load add-on installed by this application at Blender|
+|0.2|2017.4.2|[1] Support macOS<br>[2] Add feature<br> - Link button to Add-on repository<br>[3] Add Case-insensitive search<br>[4] Fix bug<br> - Failed to install when ```__init__.py``` is located on the top directory|
 |0.1|2017.3.25|First release for testing|
 
 
@@ -70,7 +77,7 @@ https://github.com/nutti/Blender-Add-on-Manager/tree/develop
 
 ### Testing
 
-only applicate is available.
+only application is available.
 
 #### Application
 
@@ -121,7 +128,7 @@ To build and launch server for release. (Linux only)
  $ bower install
  $ gulp
 
-# make configuration file for logging to GitHub
+# make configuration file for logging into GitHub
  $ vim config.json
 # {
 #     "github": {
@@ -148,8 +155,6 @@ To build and launch server for release. (Linux only)
 ```
 
 
-
-
 ## License
 
 MIT License.
diff --git a/README_jp.md b/README_jp.md
@@ -3,17 +3,27 @@
 GitHubで公開されているアドオンを管理するためのツールです。
 本ツールを利用することで、GitHubで公開されている全てのアドオンについて管理することができます。
 
-**現在、テスト目的でツールを公開しています。不具合の修正は適宜行っていますが、まだ多数の潜在的な不具合が存在すると考えられますので、ご利用は自己責任で行ってください。**
 
 ## ダウンロードURL
 
 |バージョン|URL|
 |---|---|
-|0.1|Download|
+|1.1|[Download](https://github.com/nutti/Blender-Add-on-Manager/releases/tag/v1.1)|
+|1.0|[Download](https://github.com/nutti/Blender-Add-on-Manager/releases/tag/v1.0)|
+|0.3|[Download](https://github.com/nutti/Blender-Add-on-Manager/releases/tag/v0.3)|
+|0.2|[Download](https://github.com/nutti/Blender-Add-on-Manager/releases/tag/v0.2)|
+|0.1|[Download](https://github.com/nutti/Blender-Add-on-Manager/releases/tag/v0.1)|
+
 
 ## 対応言語
 
-英語のみ
+現在、本アプリケーションでサポートしている言語は以下の通りです。
+サポートしたい言語がありましたら、翻訳内容を送ってください。
+
+* 英語（デフォルト）
+* スペイン語
+  * 提供者：@Oxer
+
 
 ## 提供機能
 
@@ -24,6 +34,9 @@ GitHubで公開されているアドオンを管理するためのツールで
   * GitHub上で公開されているアドオンのインストール
   * インストール済みのアドオンのアンインストール（サポートレベルがExternalのアドオンのみ）
   * GitHub上で公開されているアドオンのアップデート
+  * お気に入り
+* 異なるバージョンのBlender間でのアドオン移行
+
 
 ## 使い方
 
@@ -35,11 +48,19 @@ GitHubで公開されているアドオンを管理するためのツールで
 Blenderアドオンマネージャは現在進行中のプロジェクトです。
 より詳細な情報については、以下のリンク先を参照してください。
 
+* [Blender Artist Thread](https://blenderartists.org/forum/showthread.php?418833-Blender-Add-on-Manager-(About-2-000-add-ons-are-available))
+
+
 ## 更新履歴
 
-|バージョン|URL|
-|---|---|
-|0.1|テスト版公開|
+|バージョン|リリース日|更新内容|
+|---|---|---|
+|1.1|2017.XX.X|[1] 新機能追加<br> - お気に入り<br> - 異なるバージョン間でのアドオン移行<br>[2] 言語サポート<br> - スペイン語<br>[3] スクロールバー追加<br>[4] データベースのAPIを更新 (サーバ)<br>[5] データベースからのアドオン削除アルゴリズム改良 (サーバ)|
+|1.0|2017.11.9|[1] 新機能追加<br> - カスタムディレクトリ上に配置されたアドオンの管理<br> - アドオンのブロック<br>[2] アドオンの表示順序選択<br>[3] リンク切れのアドオン削除 (サーバ)<br>[4] バグ修正<br> - パスに "." を含むアドオン情報の取得に失敗|
+|0.3|2017.4.11|[1] configファイルとデータベースファイルをユーザのホームディレクトリに配置<br>[2] サーバサイドプログラムの安定性向上<br>[3] エラー時にポップアップ表示<br>[4] バグ修正<br> - 開発元が未確認のためにmacOSでアプリを起動できない<br> - 本アプリでインストールしたアドオンをBlenderで開けない|
+|0.2|2017.4.2|[1] macOSサポート<br>[2] 新機能追加<br> - アドオンのリポジトリへのリンクジャンプ<br>[3] 大文字/小文字を判別しない検索<br>[4] バグ修正<br> - ```__init__.py``` がディレクトリ直下に置かれていた場合にインストールできない|
+|0.1|2017.3.25|テスト向けリリース|
+
 
 ## 不具合報告、機能追加依頼
 
@@ -52,6 +73,89 @@ https://github.com/nutti/Blender-Add-on-Manager-for-GitHub/issues
 本ツールの開発に対する修正などを行いたい方は **develop** ブランチへPull Requestすることで修正依頼を行ってください。
 **master** ブランチへのPull Requestは禁止します。
 
+https://github.com/nutti/Blender-Add-on-Manager/tree/develop
+
+
+### テスト
+
+テストはアプリケーションのみ対応しています。
+
+#### アプリケーション
+
+アプリケーションをビルド＆テストするためには、以下の手順に従います。
+
+```sh
+ $ git clone https://github.com/nutti/Blender-Add-on-Manager.git
+ $ cd Blender-Add-on-Manager
+ $ npm install
+ $ bower install
+ $ gulp
+ $ gulp start
+```
+
+### リリース
+
+#### アプリケーション
+
+アプリケーションのリリース版は、以下の手順で作成します。
+
+```sh
+ $ git clone https://github.com/nutti/Blender-Add-on-Manager.git
+ $ cd Blender-Add-on-Manager
+ $ npm install
+ $ bower install
+ $ gulp
+
+ $ npm run build     # Windows/Linux向け
+
+or
+
+ $ node build_mac.js     # MacOS向け
+```
+
+#### サーバ
+
+サーバサイドプログラムのリリース版のビルドと、各種サーバの立ち上げは以下の手順で行います（Linux上でのみ動作可能です）。
+
+
+```sh
+ $ git clone https://github.com/nutti/Blender-Add-on-Manager.git
+ $ cd Blender-Add-on-Manager
+ $ vim src/lib/js/blam-constants.js
+# クライアントの定数定義 "USER_DIR" をコメント
+# サーバの定数定義 "USER_DIR" のコメントを外す
+
+ $ npm install
+ $ npm install electron@1.7.9
+ $ bower install
+ $ gulp
+
+# GitHubにログインするための設定ファイルを作成
+ $ vim config.json
+# {
+#     "github": {
+#          "username": <username>,
+#          "password": <password>
+#     }
+# }
+
+# Pythonの依存するパッケージをインストール
+ $ mkdir venv
+ $ virtualenv venv
+ $ source venv/bin/activate
+ $ pip install -r requirements.txt
+
+# APIサーバを立ち上げ
+ $ cd src/server
+ $ sh run.sh
+# GitHubからのアドオン情報収集デーモンを立ち上げ
+ $ cd ../..
+ $ cd build/server/js
+ $ forever start bladdon_collector.js
+# アドオンデータベースクリーナの立ち上げ (任意)
+ $ node bladdon_cleaner.js
+```
+
 ## ライセンス
 
 本ツールは **MIT** ライセンスが適用されています。
diff --git a/main.js b/main.js
@@ -9,7 +9,7 @@ var crashReporter = electron.crashReporter;
 
 var mainWindow = null;
 
-const DEBUG = true;
+const DEBUG = false;
 
 crashReporter.start({
     productName: 'Blender Add-on Manager',

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "Blender_Add-on_Manager",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Blender Add-on Manager",
   "main": "main.js",
   "scripts": {