Skip to content

Commit

Permalink
Merge pull request #1189 from kmuto/update-quickstartdoc
Browse files Browse the repository at this point in the history 
review-updateについてのドキュメント記載とマイナーな修正
  • Loading branch information
@kmuto
kmuto authored Nov 2, 2018
2 parents 994e06e + 7b540de commit 26a190b
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 6 deletions.
29 changes: 26 additions & 3 deletions doc/quickstart.ja.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Re:VIEW は GNU Lesser General Public License Version 2.1 に基づいて配布

このドキュメントでは、Re:VIEW のセットアップから変換の例までを簡単に説明します。

このドキュメントは、Re:VIEW 2.0 に基づいています。
このドキュメントは、Re:VIEW 3.0 に基づいています。

## セットアップ

Re:VIEW は Ruby 言語で記述されており、Linux/Unix 互換システムで動作します。Mac OS X および Windows Cygwin でも動作可能です。Ruby gem あるいは Git のいずれかを使ってダウンロード・展開します。
Re:VIEW は Ruby 言語で記述されており、Linux/Unix 互換システムで動作します。macOS および Windows Cygwin でも動作可能です。Ruby gem あるいは Git のいずれかを使ってダウンロード・展開します。

なお、Re:VIEW フォーマット自体は文字で表現されたタグが付いている以外は単なるテキストファイルなので、エディタ、OS については UTF-8 文字エンコーディングさえ使用できれば制限はありません。

Expand Down Expand Up @@ -77,6 +77,8 @@ $ review-init ドキュメント名
* layouts : レイアウトファイルの配置フォルダ
* style.css : サンプルスタイルシート
* sty : スタイルファイル配置フォルダ（TeX 用）
* doc : 本ドキュメントを含む使い方のドキュメント
* lib : 主に rake コマンドの詳細ルールファイル

review-init コマンドによらず、独自に作業フォルダを作成してもかまいません。

Expand Down Expand Up @@ -204,9 +206,30 @@ $ review-vol
$ review-index --level 掘り下げる見出しレベル数 -a
```

## ドキュメントフォルダを新しい Re:VIEW バージョンに追従する方法

Re:VIEW は定期的に更新されています。おおむね後方互換性を保持していますが、新しいバージョン固有の機能を利用したいときには、ドキュメントフォルダを新しいバージョンに更新する review-update コマンドを利用します。

```bash
$ review-update
** review-update はプロジェクトを 3.0.0 に更新します **
config.yml: 'review_version' を '3.0' に更新しますか? [y]/n ←Enterで実行
Rakefile は Re:VIEW バージョンのもの (/.../review/samples/sample-book/src/Rakefile) で置き換えられます。本当に進めますか? [y]/n
lib/tasks/review.rake は Re:VIEW バージョンのもの (/.../review/samples/sample-book/src/lib/tasks/review.rake) で置き換えられます。本当に進めますか? [y]/n
INFO: 新しいファイル /.../sty/plistings.sty が作成されました。
/.../sty/reviewmacro.sty は Re:VIEW バージョンのもの (/.../review/templates/latex/review-jsbook/reviewmacro.sty) で置き換えられます。本当に進めますか? [y]/n
INFO: 新しいファイル /.../sty/README.md が作成されました。
INFO: 新しいファイル /.../sty/review-custom.sty が作成されました。
INFO: 新しいファイル /.../sty/review-jsbook.cls が作成されました。
INFO: 新しいファイル /.../sty/review-style.sty が作成されました。
INFO: 新しいファイル /.../sty/review-base.sty が作成されました。
INFO: 新しいファイル /.../sty/gentombow09j.sty が作成されました。
完了しました。
```

## クレジット

Re:VIEW は、青木峰郎によって最初に作成されました。武藤健志がこの開発・保守を引き継ぎ、2018年9月時点では、武藤健志、高橋征義、角征典が開発・保守を継続しています。
Re:VIEW は、青木峰郎によって最初に作成されました。武藤健志がこの開発・保守を引き継ぎ、2018年11月時点では、武藤健志、高橋征義、角征典が開発・保守を継続しています。

バグ・パッチの報告、開発者用メーリングリストなどについての情報は、

Expand Down
28 changes: 25 additions & 3 deletions doc/quickstart.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ Re:VIEW is free software under the terms of the GNU Lesser General Public Licens

This article describes how to setup Re:VIEW and use it.

The supported version of the article is Re:VIEW 2.0.
The supported version of the article is Re:VIEW 3.0.

## Set up Re:VIEW

Re:VIEW is a software in Ruby and worked in Linux/Unix, Mac OS X, and Windows. You can install Re:VIEW with RubyGems or Git.
Re:VIEW is a software in Ruby and worked in Linux/Unix, macOS, and Windows. You can install Re:VIEW with RubyGems or Git.

Note that Re:VIEW format is plain texts with simple markups in UTF-8, so you can write it on any editors and OSes.

Expand Down Expand Up @@ -82,7 +82,8 @@ In `hello` directory, many files are generated.
* layouts : forlder for layout files
* style.css : sample stylesheet
* sty : style files for LaTeX

* doc : various documents (including this document)
* lib : detailed rule files of rake command and etc.

### writing Re:VIEW documents and converting them

Expand Down Expand Up @@ -207,6 +208,27 @@ You can also use `review-index` command to generate header list.
$ review-index --level <heading level> -a
```

## how to update the document folder to the new Re:VIEW version

Re:VIEW is updated regularly. We Re:VIEW team watch the backward compatibility carefully, but if you want to use the features in the new version, you can use review-update command to update the document folder.

```bash
$ review-update
** review-update updates your project to 3.0.0 **
config.yml: Update 'review_version' to '3.0'? [y]/n
Rakefile will be overridden with Re:VIEW version (/.../review/samples/sample-book/src/Rakefile). Do you really proceed? [y]/n
lib/tasks/review.rake will be overridden with Re:VIEW version (/.../review/samples/sample-book/src/lib/tasks/review.rake). Do you really proceed? [y]/n
INFO: new file /.../sty/plistings.sty is created.
/.../sty/reviewmacro.sty will be overridden with Re:VIEW version (/.../review/templates/latex/review-jsbook/reviewmacro.sty). Do you really proceed? [y]/n
INFO: new file /.../sty/README.md is created.
INFO: new file /.../sty/review-custom.sty is created.
INFO: new file /.../sty/review-jsbook.cls is created.
INFO: new file /.../sty/review-style.sty is created.
INFO: new file /.../sty/review-base.sty is created.
INFO: new file /.../sty/gentombow09j.sty is created.
Finished.
```

## Copyright

The original author of Re:VIEW is Minero Aoki. The current maintainer is Kenshi Muto(@kmuto), and committers are Masayoshi Takahashi and Masanori Kado (September 2018).
Expand Down

0 comments on commit 26a190b

Please sign in to comment.