docs changes

b1-pack · Dec 5, 2011 · 83b03d2 · 83b03d2
1 parent 93faad4
commit 83b03d2
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 340 deletions.
diff --git a/README b/README
@@ -0,0 +1,5 @@
+B1 Pack is an open-source software project that produces a cross-platform command-line tool and a Java library for creating and extracting file archives in the B1 archive format.
+
+To build and install the whole project with Maven go to the "parent" directory and run "mvn install".
+
+Please refer to http://dev.b1.org for more information.
diff --git a/parent/pom.xml b/parent/pom.xml
@@ -32,6 +32,20 @@
         <module>../standard</module>
         <module>../tool</module>
     </modules>
+    <mailingLists>
+        <mailingList>
+            <name>b1-pack-discuss</name>
+            <subscribe>b1-pack-discuss+subscribe@googlegroups.com</subscribe>
+            <unsubscribe>b1-pack-discuss+unsubscribe@googlegroups.com</unsubscribe>
+            <post>b1-pack-discuss@googlegroups.com</post>
+            <archive>https://groups.google.com/group/b1-pack-discuss</archive>
+        </mailingList>
+    </mailingLists>
+    <scm>
+        <developerConnection>scm:git:git@github.com:b1-pack/b1-pack.git</developerConnection>
+        <connection>scm:git:git://github.com/b1-pack/b1-pack.git</connection>
+        <url>https://github.com/b1-pack/b1-pack</url>
+    </scm>
     <distributionManagement>
         <repository>
             <id>dev.b1.org</id>
@@ -113,6 +127,11 @@
                         <target>1.6</target>
                     </configuration>
                 </plugin>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-release-plugin</artifactId>
+                    <version>2.2.1</version>
+                </plugin>
                 <plugin>
                     <artifactId>maven-site-plugin</artifactId>
                     <version>3.0</version>

diff --git a/parent/src/site/apt/index.apt.vm b/parent/src/site/apt/index.apt.vm
@@ -7,6 +7,10 @@ Introduction
  {{{./tool-usage.html}command-line tool}} and a {{{./library-usage.html}Java library}} for creating
  and extracting file archives in the {{{./standard/index.html}B1 archive format}}.
 
+ Please help us improve B1 Pack: examine the {{{https://github.com/b1-pack/b1-pack}source code}},
+ join our {{{https://groups.google.com/group/b1-pack-discuss}discussion group}},
+ {{{https://github.com/b1-pack/b1-pack/issues}report issues}}.
+
 Format Features
 
  * Unicode (UTF-8) names for files and folders inside an archive.

diff --git a/parent/src/site/apt/library-usage.apt.vm b/parent/src/site/apt/library-usage.apt.vm
@@ -1,7 +1,7 @@
  ---
  Library Usage
 
-Library Download
+Downloading
 
  Maven users can add the following dependencies to their <<<pom.xml>>> and repositories to <<<settings.xml>>> or <<<pom.xml>>>.
 

diff --git a/parent/src/site/apt/tool-usage.apt.vm b/parent/src/site/apt/tool-usage.apt.vm
@@ -1,7 +1,7 @@
  ---
  Tool Usage
 
-Download
+Downloading
 
  If you want to create, list, or extract a B1 archive, just download
  a {{{./releases/org/b1/pack/b1-pack-tool/${projectVersion}/b1-pack-tool-${projectVersion}.jar}command-line tool}} and save it as "b1-pack-tool.jar".