From bdcc67a2aa1f5bb08f42c0465d6e7e040985aa28 Mon Sep 17 00:00:00 2001 From: Ikko Eltociear Ashimine Date: Sat, 12 Oct 2024 23:48:52 +0900 Subject: [PATCH 1/2] docs: add Japanese README I created Japanese translated README. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/VisActor/VStory?shareId=XXXX-XXXX-XXXX-XXXX). --- README.ja-JP.md | 97 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 +- README.zh-CN.md | 2 +- 3 files changed, 99 insertions(+), 2 deletions(-) create mode 100644 README.ja-JP.md diff --git a/README.ja-JP.md b/README.ja-JP.md new file mode 100644 index 00000000..04584751 --- /dev/null +++ b/README.ja-JP.md @@ -0,0 +1,97 @@ +
+ + VisActor Logo + + + VisActor Logo + +
+ +
+

VStory

+
+ +
+ +VStoryは、VisActorの基盤機能を統合し、すぐに使えるデータナラティブソリューションを提供します。 + +
+ +
+ +[English](./README.md) | 简体中文 | 日本語 + +
+ +
+ +(デモビデオ) + +
+ +## 概要 + +VStoryは、VisActorの可視化システムにおけるチャートコンポーネントライブラリです。可視化チャートライブラリ[VChart](https://github.com/VisActor/VChart)、可視化文法ライブラリ[VGrammar](https://github.com/VisActor/VGrammar)、および可視化レンダリングエンジン[VRender](https://github.com/VisActor/VRender)に基づいてコンポーネントをカプセル化しています。主な機能は以下の通りです: + +1. **一つのコードで複数のプラットフォームに対応**:デスクトップ、H5、および複数の小プログラム環境に自動適応 +2. **ナラティブ指向**:注釈、アニメーション、プロセス制御、ナラティブテンプレートなどの一連の強化機能を総合的に適用してナラティブ可視化を作成 +3. **シーンの蓄積**:最終ユーザーに向けて可視化機能を蓄積し、開発者の生産性を解放 + +## リポジトリの紹介 + +このリポジトリには以下のパッケージが含まれています: + +1. [`vstory`](https://sophon-ai.bytedance.net/paas/packages/vstory/): コアパッケージ、VStoryエディター +2. [`docs`](https://sophon-ai.bytedance.net/paas/docs/): VStoryサイトのソースコード、サイト上のすべての日本語および英語のドキュメント、サンプルコードなどを含む。 + +## 🔨 使用方法 + +構築中... + +## ⌨️ 開発 + +まず、[@microsoft/rush](https://rushjs.io/pages/intro/get_started/)をグローバルにインストールします: + +```bash +$ npm i --global @microsoft/rush +``` + +次に、コードをローカルにクローンします: + +```bash +# クローン +$ git clone git@github.com:VisActor/VStory.git +$ cd VStory +# 依存関係をインストール +$ rush update +# vstoryのローカル開発を開始 +$ rush start +# サイトのローカル開発を開始 +$ rush docs +``` + +## 📖 ドキュメント + +依存関係をインストールして更新した後、docsコマンドを実行してvstoryのローカルドキュメントプレビューを開始できます: + +```bash +# vstoryドキュメントサーバーを開始 +$ rush start +``` + +## 🔗 関連リンク + +- [VCharts チャート例](https://www.visactor.io/vchart/example) +- [VChart チャートチュートリアル](https://www.visactor.io/vchart/guide/tutorial_docs/VChart_Website_Guide) +- [VChart チャート設定項目](https://www.visactor.io/vchart/option/) +- [VChart API](https://www.visactor.io/vchart/api/API/vchart) +- [VGrammar](https://www.visactor.io/vgrammar) +- [VRender](https://www.visactor.io/vrender) + +## 🤝 貢献 [](https://github.com/VisActor/VChart/blob/main/CONTRIBUTING.md#your-first-pull-request) + +貢献したい場合は、[行動規範](https://sophon-ai.bytedance.net/paas/CODE_OF_CONDUCT.md)および[貢献ガイドライン](https://sophon-ai.bytedance.net/paas/CONTRIBUTING.md)をお読みください。 + +小さな流れが川となり、最終的には海となる! + + diff --git a/README.md b/README.md index bc4d4787..5a1bf5eb 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ VStory integrates the underlying capabilities of VisActor to provide an out-of-t
-[English](./README.md) | 简体中文 +[English](./README.md) | 简体中文 | [日本語](./README.ja-JP.md)
diff --git a/README.zh-CN.md b/README.zh-CN.md index 07bcd086..49ddc969 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -19,7 +19,7 @@ VStory,整合 VisActor 底层能力,提供开箱即用的数据叙事解决
-[English](./README.md) | 简体中文 +[English](./README.md) | 简体中文 | [日本語](./README.ja-JP.md)
From d4df7ea124257cd932939dca606c399fb75f9dc7 Mon Sep 17 00:00:00 2001 From: XinYu Zhou <1843605478@qq.com> Date: Mon, 14 Oct 2024 20:13:09 +0800 Subject: [PATCH 2/2] Update README.ja-JP.md --- README.ja-JP.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.ja-JP.md b/README.ja-JP.md index 04584751..9c4b39a8 100644 --- a/README.ja-JP.md +++ b/README.ja-JP.md @@ -41,8 +41,8 @@ VStoryは、VisActorの可視化システムにおけるチャートコンポー このリポジトリには以下のパッケージが含まれています: -1. [`vstory`](https://sophon-ai.bytedance.net/paas/packages/vstory/): コアパッケージ、VStoryエディター -2. [`docs`](https://sophon-ai.bytedance.net/paas/docs/): VStoryサイトのソースコード、サイト上のすべての日本語および英語のドキュメント、サンプルコードなどを含む。 +1. [`vstory`](./packages/vstory/): コアパッケージ、VStoryエディター +2. [`docs`](./docs/): VStoryサイトのソースコード、サイト上のすべての日本語および英語のドキュメント、サンプルコードなどを含む。 ## 🔨 使用方法