Skip to content

Commit

Permalink
change document structure
Browse files Browse the repository at this point in the history
  • Loading branch information
Nishihara-Daiki committed Oct 6, 2021
1 parent 46ed0ad commit 2115cb4
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 42 deletions.
18 changes: 18 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
*日本語*

CC-BY-NCに従う。
ただし、Nishihara Daiki が所属中の組織に属する個人は、
その組織が営利目的であっても組織の活動下での使用を認める。

CC-BY-NC ライセンス
https://creativecommons.org/licenses/by-nc/4.0/deed.ja


*English*

Follows CC-BY-NC; provided, however, that individuals who
belong to the organization to which Nishihara Daiki belongs are permittedto use it in the organization even if the organization is
for commercial purposes.

CC-BY-NC licence
https://creativecommons.org/licenses/by-nc/4.0/
51 changes: 9 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,19 @@
# Chat Helper
GChat向けに、充実したChrome拡張機能を提供します。

## サポート対象
- Chromeブラウザ
- 日本語設定

## インストール方法(初めて使うときの手順)
## 詳細

Chromeウェブストア未公開のため、ソースコードをダウンロードして追加する必要があります。<br>
※gitが使える方は、クローンがお勧めです。更新時が楽です。
||手順|スクリーンショット|
|--|--|--|
|1|リポジトリをクローンまたはダウンロードします。<br>右上の Code ボタンから、Download ZIPをクリックし、<br>ダウンロードされたファイルを解凍(展開)します。|![ダウンロード手順](./docs/images/install-download.png)|
|2|Chromeの拡張機能ページ [`chrome://extensions/`](chrome://extensions/) <br>を開きます。||
|3|右上のデベロッパーモードをオンにします。|![デベロッパーモード](./docs/images/install-developer-mode.png)|
|4|左上の「パッケージ化されていない拡張機能を読み込む」から、<br>先ほど解凍(展開)したフォルダ `chat-helper-master/` の中の [`src/`](./src) を選択します。<br>インストールができたら、デベロッパーモードはオフに戻しても構いません。|![パッケージ化されていない拡張機能を読み込む](./docs/images/install-load.png)|
- [機能紹介](./docs/functions.md)
- [インストール方法/更新方法](./docs/getstart.md)
- [更新履歴](./docs/history.md)
- [免責事項](./docs/disclaimer.md)
- [開発者向け](./docs/developer.md)


## 更新方法(インストール済みの拡張機能を最新版に更新するときの手順)
## サポート対象
- Chromeブラウザ
- 日本語設定

gitで管理している方は、pullして手順4.にお進みください。
||手順|スクリーンショット|
|--|--|--|
|1|インストール時と同様にzipファイルを再度ダウンロードします。|![](./docs/images/install-download.png)|
|2|ダウンロードしたzipファイルを解凍(展開)します。||
|3|古いフォルダを新しく解凍(展開)したフォルダで **【上書き】** します。<br>もしくは、古いフォルダを削除して **同じ** 場所に新しいフォルダを保存します。<br>※別の場所に保存して読み込むと、別の拡張機能として<br>認識されてしまい、2つの拡張機能が競合します。||
|4|Chromeの拡張機能ページ [`chrome://extensions/`](chrome://extensions/) <br>を開き、更新アイコンをクリックします。<br>最新のバージョン表記に更新されたら成功です。<br>※「削除」ボタンでChromeから削除してインストールを<br>やり直す方法もありますが、その場合、<br>設定やピン止め等のメモリがリセットされてしまいます。|![](./docs/images/update_update.png)|

## 使い方
1. ブラウザ右上のアイコン <img src="./docs/images/extension_icon.png" width="16"> をクリックします。
Expand All @@ -34,27 +22,6 @@ gitで管理している方は、pullして手順4.にお進みください。
4. 設定を反映するために、chat画面を更新します。


## 機能
実装済みの機能については、[機能紹介のページ](./docs/functions.md)を参照してください。
また、オプションページでも確認できます。オプションページでは、未実装の機能も掲載されています。


## 免責事項
この拡張機能は開発途中にあります。制作者は不具合が無いよう注意を払って制作しておりますが、この拡張機能の利用に関して、利用者に何らかの不都合や損害が生じたとしても、制作者は何ら責任を負いません。
なお、動作不具合等があれば、issue等でお知らせください。


## 更新履歴
[更新履歴のページ](./docs/history.md)を参照してください。


## ライセンス
[CC-BY-NC](https://creativecommons.org/licenses/by-nc/4.0/deed.ja) 2021 Nishihara Daiki

すなわち、再配布が可能ですが営利目的には使用できません。
個人使用や共有に制限はありません。


## 使用ライブラリ
開発にあたり、以下のライブラリを使用しています。

Expand Down
3 changes: 3 additions & 0 deletions docs/disclaimer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## 免責事項
この拡張機能は開発途中にあります。制作者は不具合が無いよう注意を払って制作しておりますが、この拡張機能の利用に関して、利用者に何らかの不都合や損害が生じたとしても、制作者は何ら責任を負いません。
なお、動作不具合等があれば、issue等でお知らせください。
1 change: 1 addition & 0 deletions docs/functions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# 機能紹介 - Chat Helper
実装済みの機能を紹介します。
拡張機能のオプションページでも確認できます。オプションページでは、未実装の機能も掲載されています。

## スタイルの変更
### 行間を狭く
Expand Down
22 changes: 22 additions & 0 deletions docs/getstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@

## インストール方法(初めて使うときの手順)

Chromeウェブストア未公開のため、ソースコードをダウンロードして追加する必要があります。<br>
※gitが使える方は、クローンがお勧めです。更新時が楽です。
||手順|スクリーンショット|
|--|--|--|
|1|リポジトリをクローンまたはダウンロードします。<br>右上の Code ボタンから、Download ZIPをクリックし、<br>ダウンロードされたファイルを解凍(展開)します。|![ダウンロード手順](images/install-download.png)|
|2|Chromeの拡張機能ページ [`chrome://extensions/`](chrome://extensions/) <br>を開きます。||
|3|右上のデベロッパーモードをオンにします。|![デベロッパーモード](images/install-developer-mode.png)|
|4|左上の「パッケージ化されていない拡張機能を読み込む」から、<br>先ほど解凍(展開)したフォルダ `chat-helper-master/` の中の [`src/`](./src) を選択します。<br>インストールができたら、デベロッパーモードはオフに戻しても構いません。|![パッケージ化されていない拡張機能を読み込む](images/install-load.png)|


## 更新方法(インストール済みの拡張機能を最新版に更新するときの手順)

gitで管理している方は、pullして手順4.にお進みください。
||手順|スクリーンショット|
|--|--|--|
|1|インストール時と同様にzipファイルを再度ダウンロードします。|![](images/install-download.png)|
|2|ダウンロードしたzipファイルを解凍(展開)します。||
|3|古いフォルダを新しく解凍(展開)したフォルダで **【上書き】** します。<br>もしくは、古いフォルダを削除して **同じ** 場所に新しいフォルダを保存します。<br>※別の場所に保存して読み込むと、別の拡張機能として<br>認識されてしまい、2つの拡張機能が競合します。||
|4|Chromeの拡張機能ページ [`chrome://extensions/`](chrome://extensions/) <br>を開き、更新アイコンをクリックします。<br>最新のバージョン表記に更新されたら成功です。<br>※「削除」ボタンでChromeから削除してインストールを<br>やり直す方法もありますが、その場合、<br>設定やピン止め等のメモリがリセットされてしまいます。|![](images/update_update.png)|

0 comments on commit 2115cb4

Please sign in to comment.