Skip to content

Commit

Permalink
Merge pull request #8 from vroncevic/dev
Browse files Browse the repository at this point in the history
[gen_cc_mod] Updated docs
  • Loading branch information
vroncevic committed Oct 3, 2020
2 parents bf57c20 + a59ef6e commit 5d46f97
Show file tree
Hide file tree
Showing 108 changed files with 2,817 additions and 80 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

Developed in **[bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell))** code: **100%**.

[![gen_cc_mod shell checker](https://github.com/vroncevic/gen_cc_mod/workflows/gen_cc_mod%20shell%20checker/badge.svg)](https://github.com/vroncevic/gen_cc_mod/actions?query=workflow%3A%22gen_cc_mod+shell+checker%22)

The README is used to introduce the modules and provide instructions on
how to install the modules, any machine dependencies it may have and any
other information that should be provided before the modules are installed.
Expand Down Expand Up @@ -41,6 +43,8 @@ cp -R ~/sh_tool/log/ /root/scripts/gen_cc_mod/ver.1.0/

Or You can use docker to create image/container.

[![gen_cc_mod docker checker](https://github.com/vroncevic/gen_cc_mod/workflows/gen_cc_mod%20docker%20checker/badge.svg)](https://github.com/vroncevic/gen_cc_mod/actions?query=workflow%3A%22gen_cc_mod+docker+checker%22)

### Usage

```
Expand Down
Binary file modified docs/build/doctrees/environment.pickle
100755 → 100644
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
100755 → 100644
Binary file not shown.
Empty file modified docs/build/html/.buildinfo
100755 → 100644
Empty file.
34 changes: 23 additions & 11 deletions docs/build/html/_sources/index.rst.txt
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
GEN_CC_MOD
gen_cc_mod
-----------

.. toctree::
:hidden:

self

**gen_cc_mod** is shell tool for generating C++ modules.

Developed in `bash <https://en.wikipedia.org/wiki/Bash_(Unix_shell)>`_ code: **100%**.

|GitHub shell checker|

.. |GitHub shell checker| image:: https://github.com/vroncevic/gen_cc_mod/workflows/gen_cc_mod%20shell%20checker/badge.svg
:target: https://github.com/vroncevic/gen_cc_mod/actions?query=workflow%3A%22gen_cc_mod+shell+checker%22

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.
Expand All @@ -25,7 +25,12 @@ other information that should be provided before the tool is installed.
.. |Documentation Status| image:: https://readthedocs.org/projects/gen_cc_mod/badge/?version=latest
:target: https://gen_cc_mod.readthedocs.io/projects/gen_cc_mod/en/latest/?badge=latest

INSTALLATION
.. toctree::
:hidden:

self

Installation
-------------

Navigate to release `page`_ download and extract release archive.
Expand All @@ -42,13 +47,20 @@ To install **gen_cc_mod** type the following:
cp -R ~/sh_tool/conf/ /root/scripts/gen_cc_mod/ver.1.0/
cp -R ~/sh_tool/log/ /root/scripts/gen_cc_mod/ver.1.0/
DEPENDENCIES
Or You can use Docker to create image/container.

|GitHub docker checker|

.. |GitHub docker checker| image:: https://github.com/vroncevic/gen_cc_mod/workflows/gen_cc_mod%20docker%20checker/badge.svg
:target: https://github.com/vroncevic/gen_cc_mod/actions?query=workflow%3A%22gen_cc_mod+docker+checker%22

Dependencies
-------------

**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
Shell tool structure
---------------------

**gen_cc_mod** is based on MOP.
Expand All @@ -70,7 +82,7 @@ Code structure:
└── log/
└── gen_cc_mod.log
COPYRIGHT AND LICENCE
Copyright and licence
----------------------

|License: GPL v3| |License: Apache 2.0|
Expand All @@ -83,7 +95,7 @@ COPYRIGHT AND LICENCE

Copyright (C) 2017 by `vroncevic.github.io/gen_cc_mod <https://vroncevic.github.io/gen_cc_mod>`_

This tool is free software; you can redistribute it and/or modify it
**gen_cc_mod** 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.

Empty file modified docs/build/html/_static/ajax-loader.gif
100755 → 100644
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/build/html/_static/basic.css
100755 → 100644
Empty file.
Empty file modified docs/build/html/_static/comment-bright.png
100755 → 100644
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/build/html/_static/comment-close.png
100755 → 100644
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/build/html/_static/comment.png
100755 → 100644
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/build/html/_static/css/badge_only.css
100755 → 100644

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

0 comments on commit 5d46f97

Please sign in to comment.