READMEに記載

readme.md

@@ -1,27 +1,45 @@
-* 第１段階の学習
-  * 音声データを用意する
-    * ２つのディレクトリに、入出力の音声データを置く（ファイル名を揃える）
-  * 音響特徴量切り出しをする
-    * scripts/extract_acoustic_feature.py
-  * 学習を回す
-    * train.py
-  * 実際に使用する
-    * scripts/voice_conversion_test.py
-* 第２段階の学習
-  * 音声データを用意する
-    * １つのディレクトリの超大量の結月ゆかり音声データを置く
-  * 音響特徴量切り出しをする
-    * scripts/extract_spectrogram_pair.py
-  * 学習を回す
-    * train_sr.py
-  * 実際に使用する
-    * scripts/super_resolution_test.py
-  * 実際に使う
-    * SuperResolutionクラスとAcousticConverterクラスを使ってモデルを読み込ませればいい
-    * [サンプルコート](https://github.com/Hiroshiba/become-yukarin/blob/ipynb/show%20vc%20and%20sr.ipynb)
-* 参考
+# 使い方
+
+## 必要なライブラリのインストール
+```bash
+pip install -r requirements.txt
+```
+
+## 学習させる
+学習用のPythonスクリプトを実行するには、`become_yukarin`ライブラリをパス（PYTHONPATH）に通す必要があります。
+例えば`scripts/extract_acoustic_feature.py`を以下のように書いて、パスを通しつつ実行します。
+
+```bash
+PYTHONPATH=`pwd` python scripts/extract_acoustic_feature.py ---
+```
+
+## 第１段階の学習
+* 音声データを用意する
+  * ２つのディレクトリに、入出力の音声データを置く（ファイル名を揃える）
+* 音響特徴量切り出しをする
+  * scripts/extract_acoustic_feature.py
+* 学習を回す
+  * train.py
+* 実際に使用する
+  * scripts/voice_conversion_test.py
+
+## 第２段階の学習
+* 音声データを用意する
+  * １つのディレクトリの超大量の結月ゆかり音声データを置く
+* 音響特徴量切り出しをする
+  * scripts/extract_spectrogram_pair.py
+* 学習を回す
+  * train_sr.py
+* 実際に使用する
+  * scripts/super_resolution_test.py
+* 実際に使う
+  * SuperResolutionクラスとAcousticConverterクラスを使ってモデルを読み込ませればいい
+  * [サンプルコード](https://github.com/Hiroshiba/become-yukarin/blob/ipynb/show%20vc%20and%20sr.ipynb)
+
+## 参考
   * [ipynbブランチ](https://github.com/Hiroshiba/become-yukarin/tree/ipynb)に大量にサンプルが置いてある
 
+## ファイル構造
 ```
 ├── become_yukarin  # このディレクトリは外から使えることを想定
 │   ├── __init__.py