ZOOKEEPER-3436 enhance / format README_packaging.md

Mate Szalay-Beko · Mate Szalay-Beko · commit a2ac025a0c18 · 2019-09-04T12:36:09.000+02:00
Change-Id: Ie9b433f011ba6c15cd09a45672d45509da84da13
diff --git a/README_packaging.md b/README_packaging.md
@@ -8,70 +8,72 @@ http://bigtop.apache.org/
 
 ## Requirements
 
-ant (recommended version 1.9.4 or later for concurrent JUnit test execution) or maven
-gcc, cppunit and python-setuptools are required to build
-C and python bindings.
+- ant (recommended version 1.9.4 or later for concurrent JUnit test execution) or maven to build the java code
+- gcc, cppunit and python-setuptools are required to build C and python bindings.
 
 On RHEL machine:
 
-`yum install cppunit`
-`yum install python-setuptools`
+```
+yum install cppunit
+yum install python-setuptools
+```
 
 On Ubuntu:
 
-`apt-get --install cppunit`
-`apt-get --install python-setuptools`
+```
+apt-get install cppunit
+apt-get install python-setuptools
+```
 
 
+## Package build command (using maven)
 
-## Package build command (using ant)
+Commands to clean everything and build the tarball package without executing the tests:
+ 
+```
+mvn clean -Pfull-build
+mvn install -Pfull-build -DskipTests
+```
+
+Optional parameters you might consider when using maven:
+-  `-DskipTests`          -   this parameter will skip both java and C++ unit test execution during the build
+-  `-Pfull-build`         -   activates the full-build profile, causing the C client and python code to be built
+-  `-Pc-test-coverage`    -   activates the test coverage calculation during the execution of C client tests
 
-Command to build tarball package: `ant tar`
+Please note: if you don't provide the `-Pfull-build` parameter, then the C client will not be built, the C client tests
+will not be executed and the previous C client builds will no be cleaned up (e.g. with simply using `mvn clean`).
 
-`zookeeper-<version>.tar.gz` tarball file structure layout
+`zookeeper-assembly/target/apache-zookeeper-<version>-bin.tar.gz` tarball file structure layout:
 
-  /bin                               - User executable
-  /sbin                              - System executable
-  /libexec                           - Configuration boot trap script
-  /lib                               - Library dependencies
-  /docs                              - Documents
-  /share/zookeeper                   - Project files
+- `/bin`    - User executables
+- `/conf`   - Configuration files
+- `/lib`    - ZooKeeper JAR files and all the required java library dependencies
+- `/docs`   - Documents
+- `/usr`    - Native artifacts (only present if `-Pfull-build` used)
+  
+Beside the binary tarball, you can find the whole original source project packaged into: 
+`zookeeper-assembly/target/apache-zookeeper-<version>.tar.gz`
 
-Command to build tarball package with native components: `ant package-native tar`
 
-`zookeeper-<version>-lib.tar.gz` tarball file structure layout
+## Package build command (using ant)
 
-  /bin                               - User executable
-  /lib                               - Native libraries
-  /include/zookeeper                 - Native library headers
+**Command to build tarball package:** `ant tar`
 
+`zookeeper-<version>.tar.gz` tarball file structure layout:
 
-## Package build command (using maven)
+- `/bin`              - User executable
+- `/sbin`             - System executable
+- `/libexec`          - Configuration boot trap script
+- `/lib`              - Library dependencies
+- `/docs`             - Documents
+- `/share/zookeeper`  - Project files
 
-Command to clean everything and build the tarball package without executing the tests: 
-`mvn clean -Pfull-build && mvn install -Pfull-build -DskipTests`
 
+**Command to build tarball package with native components:** `ant package-native tar`
 
-Optional parameters you might consider when using maven:
-  `-DskipTests`          -   this parameter will skip both java and C++ unit test execution during the build
-  `-Pfull-build`         -   activates the full-build profile, causing the C client to be built
-  `-Pc-test-coverage`    -   activates the test coverage calculation during the execution of C client tests
+`zookeeper-<version>-lib.tar.gz` tarball file structure layout:
 
+- `/bin`                 - User executable
+- `/lib`                 - Native libraries
+- `/include/zookeeper`   - Native library headers
 
-Please note: if you don't provide the `-Pfull-build` parameter, then the C client will not be built, the C client tests
-will not be executed and the previous C client builds will no be cleaned up (e.g. with 'mvn clean').
-
-`zookeeper-assembly/target/apache-zookeeper-<version>-bin.tar.gz` tarball file structure layout
-
-  /bin                               - User executables
-  /conf                              - Configuration files
-  /lib                               - ZooKeeper JAR files and all the required java library dependencies
-  /docs                              - Documents
-  /usr                               - Native artifacts (only present if `-Pfull-build` used)
-  /usr/bin                               - User executable
-  /usr/lib                               - Native libraries
-  /usr/include/zookeeper                 - Native library headers
-  
-  
-Beside the binary tarball, you can find the whole original source project packaged into: 
-`zookeeper-assembly/target/apache-zookeeper-<version>.tar.gz`
