OSDN Git Service

改行コード指定
[jindolf/JinParser.git] / README.txt
1 [UTF-8 Japanese]
2
3                              JinParserライブラリ
4                                   README
5
6                                               Copyright(c) 2009 olyutorskii
7
8
9 === JinParserとは ===
10
11  JinParserライブラリは、CGIゲーム「人狼BBS」のクライアント制作者向けに作られた
12 Javaライブラリです。
13  このアーカイブは、JinParserライブラリの開発資産を、ある時点で凍結したものです。
14
15  Jindolfは、CGIゲーム「人狼BBS」の専用クライアント開発プロジェクトです。
16  JinParserは、Jindolf以外の人狼BBSクライアント製作者向けに、
17 JindolfのXHTML文書パース機能を提供することを目的に発足した、
18 派生プロジェクトです。
19
20 ※ このアーカイブにはJindolfの実行バイナリは含まれていません。
21   Jindolfを動かしたい方は、jindolfで始まり拡張子が*.jarであるファイルを
22   別途入手してください。
23 ※ 人狼BBSのURLは [ http://homepage2.nifty.com/ninjinia/ ] まで
24 ※ 人狼BBSを主催するninjin氏は、JinParserの製作に一切関与していません。
25   JinParserに関する問い合わせををninjin氏へ投げかけないように!約束だよ!
26
27
28 === ソースコードに関して ===
29
30  - JinParserはJava言語(JLS3)で記述されたプログラムです。
31  - JinParserは他のプログラムに組み込まれて利用されるライブラリです。
32    JARファイルによるライブラリ提供や、他プロジェクトのソースツリーへの
33    マージの形で利用される事を想定しています。
34  - JinParserはJRE1.5に準拠したJava実行環境で利用できるように作られています。
35    原則として、JRE1.5に準拠した実行系であれば、プラットフォームを選びません。
36
37
38 === 依存ライブラリ ===
39
40  - JinParserはビルドに際してJinCoreライブラリを必要とします。
41    開発時はMaven等を用いてJinCoreライブラリを用意してください。
42
43
44 === アーカイブ管理体制 ===
45
46   このアーカイブは、UTF-8による開発環境を前提として構成されています。
47   このアーカイブの原本となる開発資産は、
48       http://hg.sourceforge.jp/view/jindolf/JinParser/
49   を上位に持つMercurialリポジトリで管理されています。
50
51
52 === 開発プロジェクト運営元 ===
53
54   http://sourceforge.jp/projects/jindolf/devel/ まで。
55
56
57 === ディレクトリ内訳構成 ===
58
59 基本的にはMaven2のmaven-archetype-quickstart構成に準じます。
60
61 ./README.txt
62     あなたが今見てるこれ。
63
64 ./CHANGELOG.txt
65     変更履歴。
66
67 ./LICENSE.txt
68     ライセンスに関して。
69
70 ./pom.xml
71     Maven2用プロジェクト構成定義ファイル。
72
73 ./build.xml
74     Ant用追加タスク。
75
76 ./src/main/java/
77     Javaのソースコード。
78
79 ./src/main/resources/
80     プロパティファイルなどの各種リソース。
81
82 ./src/test/java/
83     JUnit 4.* 用のユニットテストコード。
84
85 ./src/test/java/sample/
86     サンプルのパーサ実装。
87
88 ./src/main/config/checks.xml
89     Checkstyle用configファイル。
90
91 ./src/main/config/pmdrules.xml
92     PMD用ルール定義ファイル。
93
94 ./src/main/assembly/descriptor.xml
95     ソースアーカイブ構成定義ファイル。
96
97
98 --- EOF ---