From 8499c25b67c6b0c292fda506aa3d9c388e949485 Mon Sep 17 00:00:00 2001 From: yyc12345 Date: Sun, 14 Jan 2024 21:25:12 +0800 Subject: [PATCH] add redist folder. fix doc and readme --- .gitignore | 2 ++ README.md | 9 +-------- README_ZH.md | 5 +---- docs/docs/zh-cn/compile-distribute-plugin.md | 1 + docs/docs/zh-cn/tech-infos.md | 2 ++ 5 files changed, 7 insertions(+), 12 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ed604af --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +# disable distribution build folder +redist/ diff --git a/README.md b/README.md index 707e025..a196ee0 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,4 @@ BBP NG, abbr **B**allance **B**lender **P**lugin **N**ext **G**eneration. -## Brief Introduction - -The next generation of original Ballance Blender Helper. This plugin is fully rewritten. -This plugin still work in progress. The development will be pushed into `ng` branch in main repository. For legacy plugin user, please visit `master` branch directly. - -## Develop Help - -Use `pip install fake-bpy-module-latest==20230627` to install the type hint library for Blender. Because fake-bpy-module do not release official 3.6 package, we need install it by choosing the most closest version of Blender 3.6 release. That what I found. +For an introduction to this plugin, installing it, compiling it, reporting bugs, etc., see the GitHub Page for this project: https://yyc12345.github.io/BallanceBlenderHelper diff --git a/README_ZH.md b/README_ZH.md index e129fd9..5c690b0 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -4,7 +4,4 @@ BBP NG，又名**B**allance **B**lender **P**lugin **N**ext **G**eneration（下一代Ballance Blender插件）。 -## 简介 - -下一代的Ballance Blender插件。此插件完全重写了上一代插件。 -此插件仍然在开发过程中。开发内容会被推送到主仓库的`ng`分支中。对于旧插件的用户，请直接访问`master`分支。 +有关此插件的介绍，安装，编译，汇报错误等，请参阅本项目的GitHub Page页面：https://yyc12345.github.io/BallanceBlenderHelper diff --git a/docs/docs/zh-cn/compile-distribute-plugin.md b/docs/docs/zh-cn/compile-distribute-plugin.md index b10f47e..fe740f7 100644 --- a/docs/docs/zh-cn/compile-distribute-plugin.md +++ b/docs/docs/zh-cn/compile-distribute-plugin.md @@ -24,6 +24,7 @@ BBP内置了一系列自定义图标，以及其组件BME需要的用于描述 * `bbp_ng/raw_icons`：原始图片文件夹。 * `bbp_ng/raw_jsons`：原始JSON文件夹。 +* `bbp_ng/tools`：编译用工具。 * `bbp_ng/.style.yapf`：代码风格描述文件 * `bbp_ng/.gitignore`：gitignore * `bbp_ng/icons/.gitkeep`：文件夹占位符 diff --git a/docs/docs/zh-cn/tech-infos.md b/docs/docs/zh-cn/tech-infos.md index cfbf112..b51e6ec 100644 --- a/docs/docs/zh-cn/tech-infos.md +++ b/docs/docs/zh-cn/tech-infos.md @@ -3,3 +3,5 @@ * BM文件标准：https://github.com/yyc12345/gist/blob/master/BMFileSpec/BMSpec_ZH.md * 制图工具链标准及`meshes`文件夹下的文件的格式：https://github.com/yyc12345/gist/blob/master/BMFileSpec/YYCToolsChainSpec_ZH.md * BMERevenge的JSON文件的格式：https://github.com/yyc12345/gist/blob/master/BMERevenge/DevDocument_v2.0_ZH.md + +本插件配合了`fake-bpy-module`模块来实现类型提示以加快开发速度。本插件目前基于Blender 3.6，因此使用`pip install fake-bpy-module-latest==20230627`来安装Blender的类型提示库。 这主要是因为`fake-bpy-module`没有发布官方的适用于Blender 3.6的包，因此我只能通过选择最接近Blender 3.6版本发布时间的每日编译版本来安装它。