Merge pull request #3 from vroncevic/dev

[gen_pm] Updated Dockerfile, docs

Dockerfile

@@ -15,4 +15,33 @@
 
 FROM debian:10
 RUN apt-get update
-RUN DEBIAN_FRONTEND=noninteractive apt-get install -yq --no-install-recommends perl perl-doc tree htop
+RUN DEBIAN_FRONTEND=noninteractive apt-get install -yq --no-install-recommends \
+ tree \
+ htop \
+ wget \
+ unzip \
+ ca-certificates \
+ openssl \
+ perl \
+ perl-doc
+
+RUN wget https://github.com/vroncevic/sh_util/archive/v1.0.0.zip
+RUN unzip v1.0.0.zip
+RUN find /sh_util-1.0.0/ -name "*.editorconfig" -type f -exec rm -Rf {} \;
+RUN mkdir -p /root/scripts/sh_util/ver.1.0/
+RUN cp -R /sh_util-1.0.0/sh_tool/bin/   /root/scripts/sh_util/ver.1.0/
+RUN cp -R /sh_util-1.0.0/sh_tool/conf/  /root/scripts/sh_util/ver.1.0/
+RUN cp -R /sh_util-1.0.0/sh_tool/log/   /root/scripts/sh_util/ver.1.0/
+RUN rm -Rf v1.0.0.zip sh_util-1.0.0
+RUN mkdir /sh_tool/
+COPY sh_tool /sh_tool/
+RUN find /sh_tool/ -name "*.editorconfig" -type f -exec rm -Rf {} \;
+RUN mkdir -p /root/scripts/gen_pm/ver.1.0/
+RUN mkdir /root/bin/
+RUN cp -R /sh_tool/bin/   /root/scripts/gen_pm/ver.1.0/
+RUN cp -R /sh_tool/conf/  /root/scripts/gen_pm/ver.1.0/
+RUN cp -R /sh_tool/log/   /root/scripts/gen_pm/ver.1.0/
+RUN rm -Rf /sh_tool/
+RUN chmod -R 755 /root/scripts/gen_pm/ver.1.0/
+RUN ln -s /root/scripts/gen_pm/ver.1.0/bin/gen_pm.sh /root/bin/gen_pm
+RUN tree /root/scripts/gen_pm/ver.1.0/

README.md

@@ -1,8 +1,8 @@
 # Generating Perl Package Module.
 
-gen_pm is shell tool for generating Perl package.
+***gen_pm*** is shell tool for generating Perl package.
 
-Developed in bash code: 100%.
+Developed in bash code: ***100%***.
 
 The README is used to introduce the tool and provide instructions on
 how to install the tool, any machine dependencies it may have and any
@@ -11,6 +11,17 @@ other information that should be provided before the tool is installed.
 [![GitHub issues open](https://img.shields.io/github/issues/vroncevic/gen_pm.svg)](https://github.com/vroncevic/gen_pm/issues)
  [![GitHub contributors](https://img.shields.io/github/contributors/vroncevic/gen_pm.svg)](https://github.com/vroncevic/gen_pm/graphs/contributors)
 
+<!-- START doctoc -->
+**Table of Contents**
+
+- [Installation](https://github.com/vroncevic/gen_pm#installation)
+- [Usage](https://github.com/vroncevic/gen_pm#usage)
+- [Dependencies](https://github.com/vroncevic/gen_pm#dependencies)
+- [Shell tool structure](https://github.com/vroncevic/gen_pm#shell-tool-structure)
+- [Docs](https://github.com/vroncevic/gen_pm#docs)
+- [Copyright and Licence](https://github.com/vroncevic/gen_pm#copyright-and-licence)
+<!-- END doctoc -->
+
 ### INSTALLATION
 
 Navigate to release [page](https://github.com/vroncevic/gen_pm/releases) download and extract release archive.
@@ -25,9 +36,9 @@ cp -R ~/sh_tool/conf/  /root/scripts/gen_pm/ver.1.0/
 cp -R ~/sh_tool/log/   /root/scripts/gen_pm/ver.1.0/
 ```
 
-Or You can use docker to create image/container.
+![alt tag](https://raw.githubusercontent.com/vroncevic/gen_pm/dev/docs/setup_tree.png)
 
-:sparkles:
+Or You can use docker to create image/container.
 
 ### USAGE
 
@@ -50,17 +61,17 @@ This tool requires these other modules and libraries:
 
 ### SHELL TOOL STRUCTURE
 
-gen_pm is based on MOP.
+***gen_pm*** is based on MOP.
 
 Shell tool structure:
 ```
 .
-├── bin
+├── bin/
 │   └── gen_pm.sh
-├── conf
+├── conf/
 │   ├── gen_pm.cfg
 │   └── gen_pm_util.cfg
-└── log
+└── log/
     └── gen_pm.log
 ```
 
@@ -72,8 +83,6 @@ More documentation and info at:
 
 * https://gen_pm.readthedocs.io/en/latest/
 
-:sparkles:
-
 ### COPYRIGHT AND LICENCE
 
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
@@ -84,5 +93,3 @@ This tool is free software; you can redistribute it and/or modify
 it under the same terms as Bash itself, either Bash version 4.2.47 or,
 at your option, any later version of Bash 4 you may have available.
 
-:sparkles:
-

docs/build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 91acac27c443b5870152d700776516ad
+config: eefad9133a0b647dbee736e33007a27a
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_sources/index.rst.txt

@@ -1,20 +1,86 @@
-.. gen_pm documentation master file, created by
-   sphinx-quickstart on Mon Mar 30 02:38:04 2020.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to gen_pm's documentation!
-==================================
+GEN_PM
+-------
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+ :hidden:
+
+ self
+
+
+gen_pm is shell tool for generating Perl package.
+
+Developed in bash code: 100%.
+
+The README is used to introduce the tool and provide instructions on
+how to install the tool, any machine dependencies it may have and any
+other information that should be provided before the tool is installed.
+
+|GitHub issues| |Documentation Status| |GitHub contributors|
+
+.. |GitHub issues| image:: https://img.shields.io/github/issues/vroncevic/gen_pm.svg
+   :target: https://github.com/vroncevic/gen_pm/issues
+
+.. |GitHub contributors| image:: https://img.shields.io/github/contributors/vroncevic/gen_pm.svg
+   :target: https://github.com/vroncevic/gen_pm/graphs/contributors
+
+.. |Documentation Status| image:: https://readthedocs.org/projects/gen_pm/badge/?version=latest
+   :target: https://gen_pm.readthedocs.io/projects/gen_pm/en/latest/?badge=latest
+
+INSTALLATION
+-------------
+Navigate to release `page`_ download and extract release archive.
+
+.. _page: https://github.com/vroncevic/gen_pm/releases
+
+To install this set of modules type the following:
+
+.. code-block:: bash
+
+   tar xvzf gen_pm-x.y.z.tar.gz
+   cd gen_pm-x.y.z
+   cp -R ~/sh_tool/bin/   /root/scripts/gen_pm/ver.1.0/
+   cp -R ~/sh_tool/conf/  /root/scripts/gen_pm/ver.1.0/
+   cp -R ~/sh_tool/log/   /root/scripts/gen_pm/ver.1.0/
+
+DEPENDENCIES
+-------------
+This tool requires these other modules and libraries:
+
+.. code-block:: bash
+
+   sh_util https://github.com/vroncevic/sh_util
+
+SHELL TOOL STRUCTURE
+---------------------
+gen_pm is based on MOP.
+
+Shell tool structure:
+
+.. code-block:: bash
+
+   .
+   ├── bin/
+   │   └── gen_pm.sh
+   ├── conf/
+   │   ├── gen_pm.cfg
+   │   └── gen_pm_util.cfg
+   └── log/
+       └── gen_pm.log
+
+COPYRIGHT AND LICENCE
+----------------------
+
+|License: GPL v3| |License: Apache 2.0|
+
+.. |License: GPL v3| image:: https://img.shields.io/badge/License-GPLv3-blue.svg
+   :target: https://www.gnu.org/licenses/gpl-3.0
 
+.. |License: Apache 2.0| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
+   :target: https://opensource.org/licenses/Apache-2.0
 
+Copyright (C) 2018 by https://vroncevic.github.io/gen_pm
 
-Indices and tables
-==================
+This tool is free software; you can redistribute it and/or modify it
+under the same terms as Bash itself, either Bash version 4.2.47 or,
+at your option, any later version of Bash 4 you may have available.
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`