OSDN Git Service

Merge develop into pomconfig
[jindolf/JinParser.git] / README.txt
1 [UTF-8 Japanese]
2
3                              J i n P a r s e r
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://ninjinix.com/ ] まで
24 ※ 人狼BBSを主催するninjin氏は、JinParserの製作に一切関与していません。
25   JinParserに関する問い合わせををninjin氏へ投げかけないように!約束だよ!
26
27
28 === ソースコードに関して ===
29
30  - JinParserはJava言語(JavaSE7)で記述されたプログラムです。
31  - JinParserは他のプログラムに組み込まれて利用されるライブラリです。
32    JARファイルによるライブラリ提供や、他プロジェクトのソースツリーへの
33    マージの形で利用される事を想定しています。
34  - JinParserはJRE1.7に準拠したJava実行環境で利用できるように作られています。
35    原則として、JRE1.7に準拠した実行系であれば、プラットフォームを選びません。
36
37
38 === 依存ライブラリ ===
39
40  - JinParserはビルドに際してJinCore、JioCema両ライブラリを必要とします。
41    開発時はMaven等を用いてこれらのライブラリを用意してください。
42
43
44 === 開発プロジェクト運営元 ===
45
46   https://ja.osdn.net/projects/jindolf/ まで。
47
48
49 === ディレクトリ内訳構成 ===
50
51 基本的にはMaven3のmaven-archetype-quickstart構成に準じます。
52
53 ./README.txt
54     あなたが今見てるこれ。
55
56 ./CHANGELOG.txt
57     変更履歴。
58
59 ./LICENSE.txt
60     ライセンスに関して。
61
62 ./SCM.txt
63     ソースコード管理に関して。
64
65 ./pom.xml
66     Maven3用プロジェクト構成定義ファイル。
67
68 ./config/checkstyle/checkstyle.xml
69     Checkstyle用configファイル。
70
71 ./config/pmd/pmdrules.xml
72     PMD用ルール定義ファイル。
73
74 ./src/assembly/src.xml
75     ソースアーカイブ構成定義ファイル。
76
77 ./src/main/java/
78     Javaのソースコード。
79
80 ./src/main/resources/
81     プロパティファイルなどの各種リソース。
82
83 ./src/test/java/
84     JUnit 4.* 用のユニットテストコード。
85
86 ./src/test/java/sample/
87     サンプルのパーサ実装。
88
89 --- EOF ---