OSDN Git Service

暫定的に1.401.3版を用意
[jindolf/JinArchiver.git] / README.txt
diff --git a/README.txt b/README.txt
new file mode 100644 (file)
index 0000000..e8ed8f5
--- /dev/null
@@ -0,0 +1,97 @@
+[UTF-8 Japanese]\r
+\r
+                               JinArchiver\r
+                                  README\r
+\r
+                                              Copyright(c) 2009 olyutorskii\r
+\r
+\r
+=== JinArchiverとは ===\r
+\r
+\r
+ JinArchiverは、人狼BBSの過去ログを独自のXML形式でローカルディスクに\r
+保存するためのツールです。\r
+\r
+※ このアーカイブにはJindolfの実行バイナリは含まれていません。\r
+  Jindolfを動かしたい方は、jindolfで始まり拡張子が*.jarであるファイルを\r
+  別途入手してください。\r
+※ 人狼BBSのURLは [ http://homepage2.nifty.com/ninjinia/ ] まで\r
+※ 人狼BBSを主催するninjin氏は、JinArchiverの製作に一切関与していません。\r
+  JinArchiverに関する問い合わせををninjin氏へ投げかけないように!約束だよ!\r
+\r
+\r
+=== 使い方 ===\r
+\r
+例) ※ F国 1507村 のアーカイブをディレクトリ/tmpに作りたい場合。\r
+\r
+java -jar jinarchiver-X.X.X.jar -land wolff -vid 1507 -outdir /tmp\r
+\r
+オプション詳細は-helpオプションで確認してください。\r
+\r
+\r
+=== ソースコードに関して ===\r
+\r
+ - JinArchiverはJava言語(JLS3)で記述されたプログラムです。\r
+ - JinArchiverはJRE1.5に準拠したJava実行環境で利用できるように作られています。\r
+   原則として、JRE1.5に準拠した実行系であれば、プラットフォームを選びません。\r
+\r
+\r
+=== アーカイブ管理体制 ===\r
+\r
+  このアーカイブは、UTF-8による開発環境を前提として構成されています。\r
+  このアーカイブの原本となる開発資産は、\r
+      http://hg.sourceforge.jp/view/jindolf/JinArchiver/\r
+  を上位に持つMercurialリポジトリで管理されています。\r
+  アーカイブの代わりにMercurialを通じて開発資産にアクセスすることにより、\r
+  任意の文字コードに変換されたJavaソースファイルや各種リソースを\r
+  容易に入手することが可能です。\r
+\r
+\r
+=== 開発プロジェクト運営元 ===\r
+\r
+  http://sourceforge.jp/projects/jindolf/ まで。\r
+\r
+\r
+=== ディレクトリ内訳構成 ===\r
+\r
+./README.txt\r
+    あなたが今見てるこれ。\r
+\r
+./CHANGELOG.txt\r
+    変更履歴。\r
+\r
+./LICENSE.txt\r
+    ライセンスに関して。\r
+\r
+./src/\r
+    Javaのソースコード。XMLなどの各種リソース。\r
+\r
+./test/\r
+    JUnit 4.* 用のテストコード。\r
+\r
+./pom.xml\r
+    Maven2用プロジェクト構成定義ファイル。\r
+\r
+./build.xml\r
+    Ant用追加タスク。\r
+\r
+./src/main/java/\r
+    Javaのソースコード。\r
+\r
+./src/main/resources/\r
+    プロパティファイルなどの各種リソース。\r
+\r
+./src/test/java/\r
+    JUnit 4.* 用のユニットテストコード。\r
+\r
+./src/main/config/checks.xml\r
+    Checkstyle用configファイル。\r
+\r
+./src/main/config/pmdrules.xml\r
+    PMD用ルール定義ファイル。\r
+\r
+./src/main/assembly/descriptor.xml\r
+    ソースアーカイブ構成定義ファイル。\r
+\r
+\r
+--- EOF ---\r