From: j8takagi <j8takagi@nifty.com>
Date: Sat, 6 Feb 2010 23:38:41 +0000 (+0900)
Subject: ドキュメントの記述追加
X-Git-Tag: v0.1~62
X-Git-Url: https://j8takagi.net/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8fbd22aa630841dcf5457cd7a6b2a2e44f5ab2fe;p=YACASL2.git

ドキュメントの記述追加
---

diff --git a/doc/Makefile b/doc/Makefile
index e356989..59511eb 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -1,5 +1,5 @@
 .PHPNY: html clean
 html: yacasl2.texi
-	@makeinfo --html $^
+	@makeinfo --html --css-ref=style.css $^
 clean:
 	@rm -rf yacasl2
diff --git a/doc/yacasl2.texi b/doc/yacasl2.texi
index 8357b35..e5e1fbb 100644
--- a/doc/yacasl2.texi
+++ b/doc/yacasl2.texi
@@ -1,7 +1,7 @@
 \input texinfo   @c -*-texinfo-*-
 @c %**start of header
 @setfilename yacasl2
-@settitle YACASL2
+@settitle YACASL2 -Linux上のCASL2処理系-
 @c %**end of header
 
 @copying
@@ -9,7 +9,7 @@ Copyright @copyright{} 2010 j8takagi
 @end copying
 
 @titlepage
-@title YACASL2 -Linux上で動作するCASL2処理系-
+@title
 
 @c The following two commands start the copyright page.
 @page
@@ -26,30 +26,95 @@ Copyright @copyright{} 2010 j8takagi
 
 @cindex chapter, first
 
-YACASL2は、Linux上で動作するオープンソースのCASL II処理系です。
+YACASL2は、Linux上で動作するオープンソースのCASL II処理系です。CASL IIは情報処理試験で用いられるアセンブラ言語で、次の資料により仕様が公開されています。
 
-CASL IIは、情報処理試験で用いられるアセンブラ言語で、仕様も公開されています。
+@quotation
+@uref{http://www.jitec.ipa.go.jp/1_00topic/topic_20081027_hani_yougo.pdf, 試験で使用する情報処理用語・プログラム言語など（2008年10月版）}［PDFファイル］
+別紙 1 アセンブラ言語の仕様
+@end quotation
 
-@uref{http://www.jitec.ipa.go.jp/1_00topic/topic_20081027_hani_yougo.pdf, 試験で使用する情報処理用語・プログラム言語など（2008年10月版）［PDFファイル］-別紙 1 アセンブラ言語の仕様}
+YACASL2は、CASL IIアセンブラ言語で記述されたファイルをアセンブルし、仮想マシンCOMET II上で実行します。アセンブルと実行は、連続で行うことも別々に行うことも可能です。
+YACASL2の動作はCASL IIの仕様に準拠しているため、情報処理試験の問題をはじめ各種参考書やサイトに記載されたCASL IIのプログラムをそのままアセンブルして実行できます。また、本パッケージ中にCASL IIのサンプルプログラムが多数収録されています。
 
-YACASL2は、CASL IIの仕様に準拠した動作をします。
-そのため、情報処理試験の問題をはじめ、各種参考書やサイトに記載されたCASL IIのプログラムをそのまま動作させることができます。
+YACASL2は、「ふつうの処理系」として動作します。ほかの多くのCASL IIエミュレーターと違い、デバッガーとして動作したり、コンピューター内部の模式図を表示したりすることはありません。そのかわり、YACASL2は、次のような動作内容をすべてテキストで出力します。
 
-また、本パッケージ中にCASL IIプログラムのサンプルが多数収録されています。
+@itemize @bullet
 
-YACASL2は、「通常の処理系」として動作します。ほかの多くのCASL IIエミュレーターと違い、デバッガーとして動作したり、コンピューター内部の模式図を表示したりすることはありません。そのかわり、YACASL2は、次のような動作内容をすべてテキストで出力します。
-
-@enumerate
 @item
 ラベルとアドレスの対応
+
 @item
 アセンブラ結果
+
 @item
 実行時のレジスタの内容
+
 @item
 実行時のメモリの内容
+@end itemize
+
+出力された動作内容は、GNU/Linuxのさまざまなツール、たとえば@command{head}、@command{tail}、@command{grep}、@command{diff}などを使って解析できます。
+
+@chapter YACASL2のインストール
+
+YACASL2をインストールするには、Linux上で次の作業が必要です。
+
+@enumerate
+
+@item
+@file{yacasl2.tar.gz}のダウンロード
+
+@item
+@file{yacasl2.tar.gz}の展開
+
+@item
+@command{casl2}、@command{comet2}、@command{dumpword}のビルド
+
+@item
+レグレッションテスト
 @end enumerate
 
-出力された動作内容は、GNU/Linuxのさまざまなツール、たとえばhead, tail, grep, diffなどを使って解析できます。
+@unnumberedsec 要件
+YACASL2は、Linux上で動作します。インストール時に、@command{tar}、@command{gcc}、@command{make}が必要です。
+
+現在動作を確認しているのは、次のディストリビューションです。
+
+@itemize @bullet
+
+@item
+Ubuntu Linux 9.04
+
+@item
+Ubuntu Linux 8.04
+
+@item
+Vine Linux 4.2
+@end itemize
+
+@section @file{yacasl2.tar.gz}のダウンロード
+
+@verbatim
+$ cd
+$ wget
+@end verbatim
+
+@section @file{yacasl2.tar.gz}の展開
+
+@verbatim
+$ tar xvzf yacasl2.tar.gz
+@end verbatim
+
+@section @command{casl2}、@command{comet2}、@command{dumpword}のビルド
+
+@verbatim
+$ cd yacasl2
+$ make
+@end verbatim
+
+@section レグレッションテスト
+
+@verbatim
+$ make check
+@end verbatim
 
 @bye