beremiz

Doc: Add about section (PR #33)

2024-04-26, Nadim Khan
ac6408084c60
Parents b73d6668eba3
Children 5df2cbc1cd1a
Doc: Add about section (PR #33)

* added about section

* updated .gitignore to exclude doc/_build/
3 files changed, 31 insertions(+), 0 deletions(-)
  • +1 -0
    .gitignore
  • +29 -0
    doc/about.rst
  • +1 -0
    doc/index.rst
    • --- a/.gitignore Fri Apr 26 09:45:02 2024 +0200
    +++ b/.gitignore Fri Apr 26 13:40:34 2024 +0530
    @@ -7,3 +7,4 @@
    **/my_*.der
    **/my_*.pem
    tests/tools/Docker/requirements.txt
    +doc/_build/**
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/doc/about.rst Fri Apr 26 13:40:34 2024 +0530
    @@ -0,0 +1,29 @@
    +About this document
    +============================
    +
    +..
    + TODO: take content from https://hg.beremiz.org/beremiz_docs/
    +
    +Who Should Read This Document
    +----------------------------------------------
    +If you are new to the Beremiz IDE and want to get started with it or upgrading from
    +previous versions then You should read this document.
    +In order to properly understand this document, it is necessary to understand at least basics of the
    +PLC and HMIs.
    +
    +Terminology
    +--------------------------------------------------
    +Throughout this manual, various phrases are used. Here is a description of some of them.
    +
    +PLC
    +^^^^
    +This means programmable logical controllers
    +
    +HMI
    +^^^^
    +This means Human Machine Interface
    +
    +Beremiz IDE
    +^^^^^^^^^^^^
    +This is the programming software for PLC which is Beremiz IDE
    +
    --- a/doc/index.rst Fri Apr 26 09:45:02 2024 +0200
    +++ b/doc/index.rst Fri Apr 26 13:40:34 2024 +0530
    @@ -8,6 +8,7 @@
    .. toctree::
    :maxdepth: 3
    + about
    overview
    install
    programming/index