Add readme descriptions 24

wangrupeng · Oct 3, 2019 · e6b5f14 · e6b5f14
1 parent 68b080e
commit e6b5f14
Show file tree

Hide file tree

Showing 10 changed files with 44 additions and 4 deletions.
diff --git a/algorithms-miscellaneous-3/README.md b/algorithms-miscellaneous-3/README.md
@@ -1,3 +1,8 @@
+## Algorithms - Miscellaneous
+
+This module contains articles about algorithms. Some classes of algorithms, e.g., [sorting](/algorithms-sorting) and
+[genetic algorithms](/algorithms-genetic), have their own dedicated modules. 
+
 ## Relevant Articles:
 
 - [Java Two Pointer Technique](https://www.baeldung.com/java-two-pointer-technique)
@@ -9,3 +14,4 @@
 - [A Guide to the Folding Technique in Java](https://www.baeldung.com/folding-hashing-technique)
 - [Creating a Triangle with for Loops in Java](https://www.baeldung.com/java-print-triangle)
 - [Efficient Word Frequency Calculator in Java](https://www.baeldung.com/java-word-frequency)
+- More articles: [[<-- prev]](/algorithms-miscellaneous-2) [[next -->]](/algorithms-miscellaneous-4)
diff --git a/algorithms-sorting/README.md b/algorithms-sorting/README.md
@@ -1,4 +1,8 @@
-## Relevant articles:
+## Algorithms - Sorting
+
+This module contains articles about sorting algorithms.
+
+### Relevant articles:
 
 - [Bubble Sort in Java](https://www.baeldung.com/java-bubble-sort)
 - [Merge Sort in Java](https://www.baeldung.com/java-merge-sort)

diff --git a/animal-sniffer-mvn-plugin/README.md b/animal-sniffer-mvn-plugin/README.md
@@ -1,3 +1,7 @@
-## Relevant articles:
+## Animal Sniffer Maven Plugin
+
+This module contains articles about the Animal Sniffer Maven Plugin
+
+### Relevant articles:
 
 [Introduction to Animal Sniffer Maven Plugin](https://www.baeldung.com/maven-animal-sniffer)
diff --git a/annotations/readme.md → annotations/README.md b/annotations/readme.md → annotations/README.md
@@ -1,2 +1,7 @@
+## Annotations
+
+This module contains articles about Java annotations
+
 ### Relevant Articles:
+
 - [Java Annotation Processing and Creating a Builder](https://www.baeldung.com/java-annotation-processing-builder)
diff --git a/antlr/README.md b/antlr/README.md
@@ -1,3 +1,7 @@
+## ANTLR
+
+This module contains articles about ANTLR
+
 ### Relevant Articles: 
 
 - [Java with ANTLR](https://www.baeldung.com/java-antlr)
diff --git a/apache-avro/README.md b/apache-avro/README.md
@@ -1,2 +1,6 @@
+## Apache Avro
+
+This module contains articles about Apache Avro
+
 ### Relevant Articles:
 - [Guide to Apache Avro](https://www.baeldung.com/java-apache-avro)
diff --git a/apache-bval/README.md b/apache-bval/README.md
@@ -1,2 +1,7 @@
+## Apache BVal
+
+This module contains articles about Apache BVal
+
 ### Relevant Articles:
+
 - [Intro to Apache BVal](https://www.baeldung.com/apache-bval)
diff --git a/apache-curator/README.md b/apache-curator/README.md
@@ -1,3 +1,7 @@
+## Apache Curator
+
+This module contains articles about Apache Curator
+
 ### Relevant Articles:
 
 - [Introduction to Apache Curator](https://www.baeldung.com/apache-curator)
diff --git a/apache-cxf/README.md b/apache-cxf/README.md
@@ -1,3 +1,7 @@
+## Apache CXF
+
+This module contains articles about Apache CXF
+
 ## Relevant Articles:
 - [Introduction to Apache CXF Aegis Data Binding](https://www.baeldung.com/aegis-data-binding-in-apache-cxf)
 - [Apache CXF Support for RESTful Web Services](https://www.baeldung.com/apache-cxf-rest-api)

diff --git a/apache-fop/README.md b/apache-fop/README.md
@@ -1,5 +1,5 @@
-=========
+## Apache FOP
 
-## Core Java Cookbooks and Examples
+This module contains articles about Apache FOP
 
 ### Relevant Articles: