diff options
| author | syuilo <syuilotan@yahoo.co.jp> | 2018-04-02 11:32:27 +0900 |
|---|---|---|
| committer | syuilo <syuilotan@yahoo.co.jp> | 2018-04-02 11:32:27 +0900 |
| commit | c8a4d62e662943ef3e279da8f20b7cae2696757c (patch) | |
| tree | 7a6cdf40bf2e0a0974c9e099780cc0521e38c4f2 | |
| parent | Fix config init script (diff) | |
| download | sharkey-c8a4d62e662943ef3e279da8f20b7cae2696757c.tar.gz sharkey-c8a4d62e662943ef3e279da8f20b7cae2696757c.tar.bz2 sharkey-c8a4d62e662943ef3e279da8f20b7cae2696757c.zip | |
Update setup docs
| -rw-r--r-- | docs/setup.en.md | 30 | ||||
| -rw-r--r-- | docs/setup.ja.md | 31 |
2 files changed, 37 insertions, 24 deletions
diff --git a/docs/setup.en.md b/docs/setup.en.md index a436d751c8..1d998b705f 100644 --- a/docs/setup.en.md +++ b/docs/setup.en.md @@ -35,32 +35,38 @@ Please install and setup these softwares: ##### Optional * [Elasticsearch](https://www.elastic.co/) - used to provide searching feature instead of MongoDB -*3.* Prepare configuration +*3.* Install Misskey +---------------------------------------------------------------- +1. `git clone -b master git://github.com/syuilo/misskey.git` +2. `cd misskey` +3. `npm install` + +*4.* Prepare configuration ---------------------------------------------------------------- 1. Copy `example.yml` of `.config` directory 2. Rename it to `default.yml` 3. Edit it -*4.* Install and build Misskey ----------------------------------------------------------------- +--- -1. `git clone -b master git://github.com/syuilo/misskey.git` -2. `cd misskey` -3. `npm install` -4. `npm run build` +Or you can generate config file via `npm run config` command. -#### Update -1. `git reset --hard && git pull origin master` -2. `npm install` -3. `npm run build` +*5.* Build Misskey +---------------------------------------------------------------- +1. `npm run build` -*5.* That is it. +*6.* That is it. ---------------------------------------------------------------- Well done! Now, you have an environment that run to Misskey. ### Launch Just `sudo npm start`. GLHF! +#### Way to Update to latest version of your Misskey +1. `git reset --hard && git pull origin master` +2. `npm install` +3. `npm run build` + ### Testing Run `npm test` after building diff --git a/docs/setup.ja.md b/docs/setup.ja.md index 6605461d9f..ed63da26c2 100644 --- a/docs/setup.ja.md +++ b/docs/setup.ja.md @@ -35,32 +35,39 @@ web-push generate-vapid-keys ##### オプション * [Elasticsearch](https://www.elastic.co/) - 検索機能を向上させるために用います。 -*3.* 設定ファイルを用意する +*3.* Misskeyのインストール +---------------------------------------------------------------- +1. `git clone -b master git://github.com/syuilo/misskey.git` +2. `cd misskey` +3. `npm install` + +*4.* 設定ファイルを用意する ---------------------------------------------------------------- 1. `.config`ディレクトリ内の`example.yml`をコピー 2. `default.yml`にリネーム 3. 編集する -*4.* Misskeyのインストール(とビルド) ----------------------------------------------------------------- +--- -1. `git clone -b master git://github.com/syuilo/misskey.git` -2. `cd misskey` -3. `npm install` -4. `npm run build` +または、`npm run config`コマンドを利用して、ガイドに従って情報を +入力して設定ファイルを生成することもできます。 -#### アップデートするには: -1. `git reset --hard && git pull origin master` -2. `npm install` -3. `npm run build` +*5.* Misskeyのビルド +---------------------------------------------------------------- +1. `npm run build` -*5.* 以上です！ +*6.* 以上です！ ---------------------------------------------------------------- お疲れ様でした。これでMisskeyを動かす準備は整いました。 ### 起動 `sudo npm start`するだけです。GLHF! +#### Misskeyを最新バージョンにアップデートする方法: +1. `git reset --hard && git pull origin master` +2. `npm install` +3. `npm run build` + ### テスト (ビルドされている状態で)`npm test` |