Skip to content

Commit

Permalink
Merge pull request #13 from vroncevic/dev
Browse files Browse the repository at this point in the history
[gen_cc_mod] refactor done, updated Dockerfile, docs
  • Loading branch information
vroncevic committed Dec 5, 2021
2 parents 5c9d1e2 + 46c2a51 commit 5124db7
Show file tree
Hide file tree
Showing 91 changed files with 13,655 additions and 16,107 deletions.
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
__pycache__/
*.py[cod]
*$py.class
.idea/
.vscode/
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
version: 2
python:
version: 2.7
version: '3.7'
sphinx:
configuration: docs/source/conf.py
formats: all
30 changes: 15 additions & 15 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@
FROM debian:10
RUN apt-get update
RUN DEBIAN_FRONTEND=noninteractive \
apt-get install -yq --no-install-recommends \
tree \
htop \
wget \
unzip \
ca-certificates \
openssl \
build-essential
apt-get install -yq --no-install-recommends \
tree \
htop \
wget \
unzip \
ca-certificates \
openssl \
build-essential

RUN wget https://github.com/vroncevic/sh_util/archive/v1.0.zip
RUN unzip v1.0.zip
Expand All @@ -36,12 +36,12 @@ RUN rm -Rf v1.0.zip sh_util-1.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_cc_mod/ver.1.0/
RUN mkdir -p /root/scripts/gen_cc_mod/ver.2.0/
RUN mkdir /root/bin/
RUN cp -R /sh_tool/bin/ /root/scripts/gen_cc_mod/ver.1.0/
RUN cp -R /sh_tool/conf/ /root/scripts/gen_cc_mod/ver.1.0/
RUN cp -R /sh_tool/log/ /root/scripts/gen_cc_mod/ver.1.0/
RUN cp -R /sh_tool/bin/ /root/scripts/gen_cc_mod/ver.2.0/
RUN cp -R /sh_tool/conf/ /root/scripts/gen_cc_mod/ver.2.0/
RUN cp -R /sh_tool/log/ /root/scripts/gen_cc_mod/ver.2.0/
RUN rm -Rf /sh_tool/
RUN chmod -R 755 /root/scripts/gen_cc_mod/ver.1.0/
RUN ln -s /root/scripts/gen_cc_mod/ver.1.0/bin/gen_cc_mod.sh /root/bin/gen_cc_mod
RUN tree /root/scripts/gen_cc_mod/ver.1.0/
RUN chmod -R 755 /root/scripts/gen_cc_mod/ver.2.0/
RUN ln -s /root/scripts/gen_cc_mod/ver.2.0/bin/gen_cc_mod.sh /root/bin/gen_cc_mod
RUN tree /root/scripts/gen_cc_mod/ver.2.0/
96 changes: 91 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,11 @@ other information that should be provided before the modules are installed.

### Installation

![Debian Linux OS](https://raw.githubusercontent.com/vroncevic/gen_cc_mod/dev/docs/debtux.png)

Navigate to release **[page](https://github.com/vroncevic/gen_cc_mod/releases)** download and extract release archive.

To install **gen_cc_mod** type the following:
To install **gen_cc_mod** type the following

```
tar xvzf gen_cc_mod-x.y.tar.gz
Expand All @@ -41,7 +43,37 @@ cp -R ~/sh_tool/conf/ /root/scripts/gen_cc_mod/ver.x.y/
cp -R ~/sh_tool/log/ /root/scripts/gen_cc_mod/ver.x.y/
```

![alt tag](https://raw.githubusercontent.com/vroncevic/gen_cc_mod/dev/docs/setup_tree.png)
Self generated setup script and execution
```
./gen_cc_mod_setup.sh
[setup] installing App/Tool/Script gen_cc_mod
Sun 05 Dec 2021 01:32:04 PM CET
[setup] copy App/Tool/Script structure
[setup] remove github editor configuration files
[setup] set App/Tool/Script permission
[setup] create symbolic link of App/Tool/Script
[setup] done
/root/scripts/gen_cc_mod/ver.2.0/
├── bin/
│   ├── center.sh
│   ├── display_logo.sh
│   └── gen_cc_mod.sh
├── conf/
│   ├── gen_cc_mod.cfg
│   ├── gen_cc_mod.logo
│   ├── gen_cc_mod_util.cfg
│   └── template/
│   ├── cc_editorconfig.template
│   ├── cc_source.template
│   └── h_header.template
└── log/
└── gen_cc_mod.log
4 directories, 10 files
lrwxrwxrwx 1 root root 50 Dec 5 13:32 /root/bin/gen_cc_mod -> /root/scripts/gen_cc_mod/ver.2.0/bin/gen_cc_mod.sh
```

Or You can use docker to create image/container.

Expand All @@ -58,24 +90,78 @@ export PATH=${PATH}:/root/bin/
# Generating module-pair (source+header file)
gen_cc_mod GTKMyOption
gen_cc_mod ver.2.0
Sun 05 Dec 2021 01:33:41 PM CET
[check_root] Check permission for current session? [ok]
[check_root] Done
_
__ _ ___ _ __ ___ ___ _ __ ___ ___ __| |
/ _` |/ _ \ '_ \ / __/ __| | '_ ` _ \ / _ \ / _` |
| (_| | __/ | | | | (_| (__ | | | | | | (_) | (_| |
\__, |\___|_| |_| \___\___| |_| |_| |_|\___/ \__,_|
|___/
Info github.io/gen_cc_mod ver.2.0
Issue github.io/issue
Author vroncevic.github.io
[gen_cc_mod] Loading basic and util configuration!
100% [================================================]
[load_conf] Loading App/Tool/Script configuration!
[check_cfg] Checking configuration file [/root/scripts/gen_cc_mod/ver.2.0/conf/gen_cc_mod.cfg] [ok]
[check_cfg] Done
[load_conf] Done
[load_util_conf] Load module configuration!
[check_cfg] Checking configuration file [/root/scripts/gen_cc_mod/ver.2.0/conf/gen_cc_mod_util.cfg] [ok]
[check_cfg] Done
[load_util_conf] Done
[gen_cc_mod] Generating file [GTKMyOption.cc]
[gen_cc_mod] Generate file [GTKMyOption.h]
[gen_cc_mod] Generating file [.editorconfig]
[gen_cc_mod] Set owner!
[gen_cc_mod] Set permission!
[logging] Checking directory [/root/scripts/gen_cc_mod/ver.2.0/log/]? [ok]
[logging] Write info log!
[logging] Done
[gen_cc_mod] Done
[check_tool] Checking tool [/usr/bin/tree]? [ok]
[check_tool] Done
.
├── GTKMyOption.cc
└── GTKMyOption.h
```

### Dependencies

**gen_cc_mod** requires next modules and libraries:
**gen_cc_mod** requires next modules and libraries
* sh_util [https://github.com/vroncevic/sh_util](https://github.com/vroncevic/sh_util)

### Shell tool structure

**gen_cc_mod** is based on MOP.

Code structure:
Shell tool structure
```
sh_tool/
├── bin/
│   ├── center.sh
│   ├── display_logo.sh
│   └── gen_cc_mod.sh
├── conf/
│   ├── gen_cc_mod.cfg
│   ├── gen_cc_mod.logo
│   ├── gen_cc_mod_util.cfg
│   └── template/
│   ├── cc_editorconfig.template
Expand All @@ -89,7 +175,7 @@ sh_tool/

[![Documentation Status](https://readthedocs.org/projects/gen_cc_mod/badge/?version=latest)](https://gen_cc_mod.readthedocs.io/projects/gen_cc_mod/en/latest/?badge=latest)

More documentation and info at:
More documentation and info at
* [https://gen_cc_mod.readthedocs.io/en/latest/](https://gen_cc_mod.readthedocs.io/en/latest/)
* [https://www.gnu.org/software/bash/manual/](https://www.gnu.org/software/bash/manual/)

Expand Down
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: e9b44a585bf570aeb30f1b6573122048
config: 470f1114689a1e0d55e4099b083b6519
tags: 645f666f9bcd5a90fca523b33c5a78b7
14 changes: 11 additions & 3 deletions docs/build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,16 @@ other information that should be provided before the tool is installed.
Installation
-------------

|Debian Linux OS|

.. |Debian Linux OS| image:: https://raw.githubusercontent.com/vroncevic/gen_cc_mod/dev/docs/debtux.png
:target: https://www.debian.org

Navigate to release `page`_ download and extract release archive.

.. _page: https://github.com/vroncevic/gen_cc_mod/releases

To install **gen_cc_mod** type the following:
To install **gen_cc_mod** type the following

.. code-block:: bash
Expand All @@ -57,7 +62,7 @@ Or You can use Docker to create image/container.
Dependencies
-------------

**gen_cc_mod** requires next modules and libraries:
**gen_cc_mod** requires next modules and libraries

* sh_util `https://github.com/vroncevic/sh_util <https://github.com/vroncevic/sh_util>`_

Expand All @@ -66,15 +71,18 @@ Shell tool structure

**gen_cc_mod** is based on MOP.

Code structure:
Shell tool structure

.. code-block:: bash
sh_tool/
├── bin/
│   ├── center.sh
│   ├── display_logo.sh
│   └── gen_cc_mod.sh
├── conf/
│   ├── gen_cc_mod.cfg
│   ├── gen_cc_mod.logo
│   ├── gen_cc_mod_util.cfg
│   └── template/
│   ├── cc_editorconfig.template
Expand Down
Binary file removed docs/build/html/_static/ajax-loader.gif
Binary file not shown.

0 comments on commit 5124db7

Please sign in to comment.