Skip to content

Commit 202322e

Browse files
committedJul 28, 2024
docs: improved the README
1 parent 8a44b81 commit 202322e

File tree

3 files changed

+73
-8
lines changed

3 files changed

+73
-8
lines changed
 

‎.github/workflows/release.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ jobs:
4141
- name: Checkout Local Repository
4242
uses: actions/checkout@v4
4343
- name: copy the README and LICENSE files to the Package folder
44-
run: cp README.md LICENSE LICENSE.*.txt "${{ env.packagePath }}"
44+
run: cp README.md README.*.md LICENSE LICENSE.*.txt "${{ env.packagePath }}"
4545
- id: version
4646
name: Get the Package version based on the package.json file
4747
# cspell: disable-next-line

‎README.ja.md

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# ![black.kit.vrcui: 非公式の LaunchPad 風 uGUI テーマ](https://kurone-kito.github.io/vrc-ui/banner.png)
2+
3+
Language: [🇬🇧](https://github.com/kurone-kito/vrc-ui/blob/main/README.md) | **🇯🇵**
4+
5+
## 💡 特徴
6+
7+
- ボタン
8+
- カード
9+
- ドロップダウン
10+
- スクロールバー / スライダー
11+
- スライドショー
12+
- トグル
13+
- 他多数!
14+
15+
## ▶ 使い方
16+
17+
### 1. VRChat Creator Companion (VCC) でレジストリをインポート
18+
19+
**[VPM カタログページ](https://kurone-kito.github.io/vpm/)** にアクセスし、
20+
**Add to VCC** ボタンをクリックします。
21+
22+
### 2. パッケージをプロジェクトにインポート
23+
24+
1. VCC で "Manage Project" ボタンをクリックします。
25+
2. "black.kit.vrcui" パッケージを見つけ、
26+
"(+) Add package" ボタンをクリックします。
27+
28+
### 3. パッケージを使用し、楽しんでください :D
29+
30+
(今後ドキュメントを追加予定)
31+
32+
## 依存関係
33+
34+
VCC を介してプロジェクトを使用する場合、
35+
以下の依存関係が自動的にインポートされます:
36+
37+
- [LaunchPad Icons (black.kit.launchpadicon)](https://github.com/kurone-kito/launchpad-icons)
38+
- [UdonSharp Toybox (black.kit.toybox)](https://github.com/kurone-kito/udonsharp-toybox)
39+
40+
## 貢献
41+
42+
このリポジトリへの貢献を歓迎します!詳細については、
43+
[CONTRIBUTING.md](https://github.com/kurone-kito/vrc-ui/blob/main/.github/CONTRIBUTING.ja.md)
44+
を参照してください。
45+
46+
## ライセンス
47+
48+
このプロジェクトは以下のオプションでデュアルライセンスです:
49+
50+
- [Creative Commons CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/deed.ja)
51+
(既定)
52+
- [MIT License](https://licenses.opensource.jp/MIT/MIT.html)
53+
54+
**既定ライセンスは Creative Commons CC BY-NC 4.0 です**
55+
MIT ライセンスを適用する場合は、次の条件のいずれかを遵守してください:
56+
57+
1. このプロジェクトは
58+
**[LaunchPad Icons](https://github.com/kurone-kito/launchpad-icons)**
59+
に依存しています。この依存関係を削除してください。
60+
2. 上記が困難な場合は、少なくとも
61+
LaunchPad Icons をあなたのプロジェクト上で公開しないようにしてください。

‎README.md

+11-7
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,29 @@
11
# ![black.kit.vrcui: Unofficial uGUI theme like the LaunchPad for VRChat worlds](https://kurone-kito.github.io/vrc-ui/banner.png)
22

3+
Language: **🇬🇧** | [🇯🇵](https://github.com/kurone-kito/vrc-ui/blob/main/README.ja.md)
4+
35
## 💡 Features
46

5-
- Badges
67
- Buttons
7-
- Panels
8+
- Cards
9+
- Dropdowns
810
- Scrollbars / Sliders
9-
- Toast
11+
- Slide shows
1012
- Toggles
1113
- ... and more!
1214

1315
## ▶ Getting Started
1416

1517
### 1. Import the registry via the VRChat Creator Companion (VCC)
1618

17-
Visit the **[VPM Catalogue page](https://kurone-kito.github.io/vpm/)** and click on the **Add to VCC** button.
19+
Visit the **[VPM Catalogue page](https://kurone-kito.github.io/vpm/)** and
20+
click on the **Add to VCC** button.
1821

1922
### 2. Import the package to your project
2023

2124
1. Click on the "Manage Project" button in the VCC
22-
2. Find the "VRCUI" package and click on the "(+) Add package" button
25+
2. Find the "black.kit.vrcui" package and click on the "(+) Add package"
26+
button
2327

2428
### 3. Use the package, enjoy :D
2529

@@ -35,8 +39,8 @@ dependencies:
3539

3640
## Contributing
3741

38-
Welcome to contribute to this repository! For more details,
39-
please refer to [CONTRIBUTING.md](.github/CONTRIBUTING.md).
42+
Welcome to contribute to this repository! For more details, please refer to
43+
[CONTRIBUTING.md](https://github.com/kurone-kito/vrc-ui/blob/main/.github/CONTRIBUTING.md).
4044

4145
## License
4246

0 commit comments

Comments
 (0)