OSDN Git Service

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