#4 Update docs

amosshi · Apr 24, 2021 · 498a4b4 · 498a4b4
1 parent 5ba37d5
commit 498a4b4
Show file tree

Hide file tree

Showing 14 changed files with 125 additions and 76 deletions.
diff --git a/CommonLib/pom.xml b/CommonLib/pom.xml
@@ -6,15 +6,16 @@
         <artifactId>freeinternals</artifactId>
         <version>2.0</version>
     </parent>
-
     <artifactId>freeinternals.commonlib</artifactId>
-    <name>freeinternals :: CommonLib</name>
-    <packaging>jar</packaging>
     <version>2.0</version>
+    <packaging>jar</packaging>
+
+    <name>freeinternals :: CommonLib</name>
+    <description>Common library for Binary File Format parsers</description>
 
     <build>
         <plugins>
         </plugins>
     </build>
 
-</project>
+</project>
diff --git a/FormatBMP/pom.xml b/FormatBMP/pom.xml
@@ -6,11 +6,12 @@
         <artifactId>freeinternals</artifactId>
         <version>2.0</version>
     </parent>
-
     <artifactId>freeinternals.format.bmp</artifactId>
-    <name>freeinternals :: FormatBMP</name>
-    <packaging>jar</packaging>
     <version>1.0</version>
+    <packaging>jar</packaging>
+
+    <name>freeinternals :: FormatBMP</name>
+    <description>Bitmap image, or Device Independent Bitmap (DIB) file format</description>
 
     <dependencies>
         <dependency>
@@ -37,4 +38,4 @@
         </plugins>
     </build>
 
-</project>
+</project>
diff --git a/FormatCLASS/pom.xml b/FormatCLASS/pom.xml
@@ -6,11 +6,12 @@
         <artifactId>freeinternals</artifactId>
         <version>2.0</version>
     </parent>
-
     <artifactId>freeinternals.format.class</artifactId>
-    <name>freeinternals :: FormatCLASS</name>
-    <packaging>jar</packaging>
     <version>12.0</version>
+    <packaging>jar</packaging>
+
+    <name>freeinternals :: FormatCLASS</name>
+    <description>The Java Virtual Machine Specification - The class File Format</description>
 
     <dependencies>
         <dependency>
@@ -38,4 +39,4 @@
         </plugins>
     </build>
 
-</project>
+</project>
diff --git a/FormatDEX/pom.xml b/FormatDEX/pom.xml
@@ -6,11 +6,12 @@
         <artifactId>freeinternals</artifactId>
         <version>2.0</version>
     </parent>
-
     <artifactId>freeinternals.format.dex</artifactId>
-    <name>freeinternals :: FormatDEX</name>
-    <packaging>jar</packaging>
     <version>0.2</version>
+    <packaging>jar</packaging>
+
+    <name>freeinternals :: FormatDEX</name>
+    <description>Dalvik Executable format</description>
 
     <dependencies>
         <dependency>
@@ -39,4 +40,4 @@
         </plugins>
     </build>
 
-</project>
+</project>
diff --git a/FormatELF/pom.xml b/FormatELF/pom.xml
@@ -6,11 +6,12 @@
         <artifactId>freeinternals</artifactId>
         <version>2.0</version>
     </parent>
-
     <artifactId>freeinternals.format.elf</artifactId>
-    <name>freeinternals :: FormatELF</name>
-    <packaging>jar</packaging>
     <version>0.2</version>
+    <packaging>jar</packaging>
+
+    <name>freeinternals :: FormatELF</name>
+    <description>Executable and Linkable Format</description>
 
     <dependencies>
         <dependency>
@@ -39,4 +40,4 @@
         </plugins>
     </build>
 
-</project>
+</project>
diff --git a/FormatJPEG/pom.xml b/FormatJPEG/pom.xml
@@ -6,11 +6,12 @@
         <artifactId>freeinternals</artifactId>
         <version>2.0</version>
     </parent>
-
     <artifactId>freeinternals.format.jpeg</artifactId>
-    <name>freeinternals :: FormatJPEG</name>
-    <packaging>jar</packaging>
     <version>2.0</version>
+    <packaging>jar</packaging>
+
+    <name>freeinternals :: FormatJPEG</name>
+    <description>JPEG or JPG is a commonly used method of lossy compression for digital images, particularly for those images produced by digital photography.</description>
 
     <dependencies>
         <dependency>
@@ -39,4 +40,4 @@
         </plugins>
     </build>
 
-</project>
+</project>
diff --git a/FormatPDF/pom.xml b/FormatPDF/pom.xml
@@ -6,11 +6,12 @@
         <artifactId>freeinternals</artifactId>
         <version>2.0</version>
     </parent>
-
     <artifactId>freeinternals.format.pdf</artifactId>
-    <name>freeinternals :: FormatPDF</name>
-    <packaging>jar</packaging>
     <version>0.5</version>
+    <packaging>jar</packaging>
+
+    <name>freeinternals :: FormatPDF</name>
+    <description>Portable Document Format (PDF), standardized as ISO 32000, is a file format developed by Adobe in 1993 to present documents, including text formatting and images, in a manner independent of application software, hardware, and operating systems.</description>
 
     <dependencies>
         <dependency>
@@ -39,4 +40,4 @@
         </plugins>
     </build>
 
-</project>
+</project>
diff --git a/FormatPE/pom.xml b/FormatPE/pom.xml
@@ -6,11 +6,12 @@
         <artifactId>freeinternals</artifactId>
         <version>2.0</version>
     </parent>
-
     <artifactId>freeinternals.format.pe</artifactId>
-    <name>freeinternals :: FormatPE</name>
-    <packaging>jar</packaging>
     <version>0.1</version>
+    <packaging>jar</packaging>
+
+    <name>freeinternals :: FormatPE</name>
+    <description>Portable Executable (PE) format is a file format for executables, object code, DLLs and others used in 32-bit and 64-bit versions of Windows operating systems.</description>
 
     <dependencies>
         <dependency>
@@ -39,4 +40,4 @@
         </plugins>
     </build>
 
-</project>
+</project>
diff --git a/FormatPNG/pom.xml b/FormatPNG/pom.xml
@@ -6,11 +6,12 @@
         <artifactId>freeinternals</artifactId>
         <version>2.0</version>
     </parent>
-
     <artifactId>freeinternals.format.png</artifactId>
-    <name>freeinternals :: FormatPNG</name>
-    <packaging>jar</packaging>
     <version>1.0</version>
+    <packaging>jar</packaging>
+
+    <name>freeinternals :: FormatPNG</name>
+    <description>Portable Network Graphics (PNG) is a raster-graphics file format that supports lossless data compression.</description>
 
     <dependencies>
         <dependency>
@@ -39,4 +40,4 @@
         </plugins>
     </build>
 
-</project>
+</project>
diff --git a/FormatZIP/pom.xml b/FormatZIP/pom.xml
@@ -6,11 +6,12 @@
         <artifactId>freeinternals</artifactId>
         <version>2.0</version>
     </parent>
-
     <artifactId>freeinternals.format.zip</artifactId>
-    <name>freeinternals :: FormatZIP</name>
-    <packaging>jar</packaging>
     <version>0.5</version>
+    <packaging>jar</packaging>
+
+    <name>freeinternals :: FormatZIP</name>
+    <description>ZIP is an archive file format that supports lossless data compression.</description>
 
     <dependencies>
         <dependency>
@@ -39,4 +40,4 @@
         </plugins>
     </build>
 
-</project>
+</project>
diff --git a/README.md b/README.md
@@ -8,23 +8,27 @@ Download
 * Download Application: https://github.com/amosshi/freeinternals/releases
 
 Supported Formats
-* Class file for JVM platform
+* [BMP](https://en.wikipedia.org/wiki/BMP_file_format) file
+* [Class](https://docs.oracle.com/javase/specs/) file
   * Programming Logic: http://www.codeproject.com/Articles/35915/Java-Class-Viewer
   * Usage Sample: https://www.codeproject.com/Articles/762980/Inside-the-Hello-World-Application-via-Java-Class
-* BMP file
-* JPEG file
-* PNG file
-* ZIP file
-* DEX file for Android (in progress)
-* ELF file for `*nix` systems (todo)
-* PE file for Windows (todo)
+* [JPEG](https://en.wikipedia.org/wiki/JPEG) file
+* [PNG](https://en.wikipedia.org/wiki/Portable_Network_Graphics) file
+* [ZIP](https://en.wikipedia.org/wiki/ZIP_(file_format)) file
+
+Will supported formats
+* [DEX](https://en.wikipedia.org/wiki/Dalvik_(software)) file for Android (in progress)
+* [ELF](https://en.wikipedia.org/wiki/Executable_and_Linkable_Format) file for `*nix` systems (todo)
+* [PE](https://en.wikipedia.org/wiki/Portable_Executable) file for Windows (todo)
 
 Legacy note
-* The orignal *Java Class Viewer* has been merged into *Binary Internals Viewer* since Apr 2021
+* The orignal *Java Class Viewer* has been retired, and merged into *Binary Internals Viewer* since Apr 2021
 
 Build the Source Code
 
 * We require the maven command line `mvn` has been installed
-* Edit `build.sh` file for the `JAVA_HOME` location, if needed
-* `./build.sh` Build the source code and create the deploy packages
+* Edit `build-quick.sh` file for the `JAVA_HOME` location, if needed
+* Run Either build scripts
+  * `./build-quick.sh` Do a quickly build, to get an running application
+  * `./build.sh` Do a full build, via execute all targets like checkstyle, spotbugs, etc.
 
diff --git a/build-quick.sh b/build-quick.sh
@@ -0,0 +1,17 @@
+#!/bin/bash
+#
+# Build quickly
+#
+
+# Please change the JAVA_HOME according to the current system settings
+
+# System default java on Ubuntu LTS Linux
+export JAVA_HOME=/usr/lib/jvm/default-java
+
+# System default java on openSUSE Linux
+#export JAVA_HOME=/usr/lib64/jvm/java
+
+mvn  clean package install
+mvn  jdeps:jdkinternals
+mvn  versions:display-dependency-updates
+
diff --git a/build.sh b/build.sh
@@ -1,33 +1,32 @@
 #!/bin/bash
 #
+# Build with all targets
+#
 
-# Please change the JAVA_HOME according to the current system settings
 
-# System default java on Ubuntu LTS Linux
-export JAVA_HOME=/usr/lib/jvm/default-java
+./build-quick.sh
 
-# System default java on openSUSE Linux
-#export JAVA_HOME=/usr/lib64/jvm/java
+mvn  source:jar
+mvn  source:aggregate
 
-mvn clean package install
+mvn  javadoc:javadoc
+mvn  javadoc:jar
+mvn  javadoc:aggregate
+mvn  javadoc:aggregate-jar
 
-mvn javadoc:javadoc
-mvn javadoc:jar
-mvn javadoc:aggregate
-mvn javadoc:aggregate-jar
+mvn  pdf:pdf
 
-mvn source:jar
-mvn source:aggregate
+mvn  checkstyle:checkstyle
+mvn  checkstyle:checkstyle-aggregate
+mvn  checkstyle:check
 
-mvn checkstyle:checkstyle
-mvn checkstyle:checkstyle-aggregate
-mvn checkstyle:check
-mvn pmd:pmd
+mvn  pmd:pmd
+mvn  spotbugs:spotbugs
+#mvn spotbugs:gui
 
-mvn pdf:pdf
+mvn  site
+mvn  site:deploy
+mvn  site:jar
 
-mvn jdeps:jdkinternals
-mvn versions:display-dependency-updates
+#mvn deploy:deploy
 
-# mvn deploy:deploy
-# mvn spotbugs:gui
diff --git a/pom.xml b/pom.xml
@@ -174,6 +174,12 @@
                 </executions>
             </plugin>
 
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-site-plugin</artifactId>
+                <version>3.9.1</version>
+            </plugin>
+
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-deploy-plugin</artifactId>
@@ -192,17 +198,30 @@
         </plugins>
     </build>
 
+    <distributionManagement>
+        <site>
+            <id>site-local</id>
+            <url>file:target/site-local</url>
+        </site>
+    </distributionManagement>
+
     <modules>
         <module>CommonLib</module>
-        <module>FormatCLASS</module>
+        <module>BinaryInternalsViewer</module>
+
+        <!-- Libs ready to use -->
         <module>FormatBMP</module>
+        <module>FormatCLASS</module>
         <module>FormatJPEG</module>
+        <module>FormatPNG</module>
         <module>FormatZIP</module>
-        <module>FormatPDF</module>
+
+        <!-- Libs still in development -->
         <module>FormatDEX</module>
         <module>FormatELF</module>
         <module>FormatPE</module>
-        <module>FormatPNG</module>
-        <module>BinaryInternalsViewer</module>
+
+        <!-- Libs on hold -->
+        <module>FormatPDF</module>
     </modules>
 </project>