add documents

git-svn-id: svn+ssh://svn.sourceforge.jp/svnroot/stigmata/digger/trunk@305 acee48c3-7b26-0410-bdac-b3d0e5314bbc

diff --git a/src/site/apt/download.apt b/src/site/apt/download.apt
new file mode 100644 (file)
index 0000000..6fdd4cb
--- /dev/null
+++ b/src/site/apt/download.apt
@@ -0,0 +1,101 @@
+ ----\r
+ Download\r
+ ----\r
+ Haruaki Tamada\r
+ ----\r
+ 2008-09-13\r
+ ----\r
+\r
+Download\r
+\r
+*License\r
+\r
+ Digger: Searching the location of classes\r
+\r
+ Apache License 2.0\r
+\r
+ Copyright (C) 2008-  Haruaki TAMADA, Ph.D.\r
+\r
+ Licensed under the Apache License, Version 2.0 (the "License"); you\r
+may not use this file except in compliance with the License. You may\r
+obtain a copy of the License at\r
+\r
+ http://www.apache.org/licenses/LICENSE-2.0\r
+\r
+ Unless required by applicable law or agreed to in writing, software\r
+distributed under the License is distributed on an "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\r
+implied. See the License for the specific language governing\r
+permissions and limitations under the License.\r
+\r
+*Requirements\r
+\r
+ *{{{http://asm.objectweb.org/}ASM}} 2.2.3\r
+\r
+ *{{{http://www.junit.org/}JUnit}} 4.1\r
+\r
+ []\r
+\r
+*Manually download\r
+\r
+ We can download release build from {{{http://sourceforge.jp/}sourceforge.jp}}. \r
+\r
+ {{{https://sourceforge.jp/projects/stigmata/files/}Download}}\r
+\r
+ We can see digger-x.x.x-bin.jar, and digger-x.x.x-src.jar.\r
+ Both packages mean as followings.\r
+\r
+ [digger-x.x.x-bin.jar] binary distribution package, contains class\r
+   files and resource files.\r
+\r
+ [digger-x.x.x-src.jar] source distribution package, contains\r
+ pom.xml, source files, resource files and documents.\r
+ \r
+*Binary download by maven2 \r
+\r
+ We can get a jar file of digger by Maven2 using below setting.\r
+First, add remote repository entry to <<<repositories>>> tag in `pom.xml.'\r
+Next, add <<<dependency>>> tag entry to <<<dependencies>>> tag in `pom.xml.'\r
+\r
+----\r
+<project>\r
+    :\r
+  <repositories>\r
+    <repository>\r
+      <id>stigmata.sourceforge.jp</id>\r
+      <name>Stigmata Maven2 Repository in sourceforge.jp</name>\r
+      <url>http://stigmata.sourceforge.jp/maven2</url>\r
+    </repository>\r
+  </repositories>\r
+    :\r
+\r
+    :\r
+  <dependencies>\r
+      :\r
+    <dependency>\r
+      <groupId>jp.sourceforge</groupId>\r
+      <artifactId>stigmata</artifactId>\r
+      <version>1.2.0</version>\r
+    </dependency>\r
+      :\r
+  </dependencies>\r
+    :\r
+</project>\r
+----\r
+\r
+*SCM\r
+\r
+**Subversion\r
+\r
+ The source can be checked out anonymously from Subversion.\r
+\r
+----\r
+$ svn checkout http://svn.sourceforge.jp/svnroot/stigmata/trunk/ stigmata\r
+----\r
+\r
+**Web access\r
+\r
+ We can browse the source code from following link.\r
+\r
+ {{http://svn.sourceforge.jp/cgi-bin/viewcvs.cgi/?root=stigmata}}\r
+\r

diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
new file mode 100644 (file)
index 0000000..aa29ac7
--- /dev/null
+++ b/src/site/apt/index.apt
@@ -0,0 +1,13 @@
+ ----\r
+ Introduction\r
+ ----\r
+ Haruaki Tamada\r
+ ----\r
+ 2008-09-13\r
+ ----\r
+\r
+Overview\r
+\r
+ This library searches location of classes from classpath, file\r
+system, jar files, zip files, and war files.\r
+\r

diff --git a/src/site/site.xml b/src/site/site.xml
index 40950a2..1785a17 100644 (file)
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -12,7 +12,7 @@
     <name>Digger</name>
     <src>images/logos/digger_logo.png</src>
     <href>http://stigmata.sourceforge.jp/digger/</href>
-    <alt>Digger: Dig up class files</alt>
+    <alt>Digger: Dig up locations of classes</alt>
   </bannerRight>
 
   <poweredBy>