# HG changeset patch
# User Nadim Khan <34601107+nadim4114@users.noreply.github.com>
# Date 1714119034 -19800
# Node ID ac6408084c607b99888bd766fbeab1f498c5a5f8
# Parent  b73d6668eba31ed637cce53bc77fc71ad69ac8e1
Doc: Add about section  (PR #33)

* added about section

* updated .gitignore to exclude doc/_build/

diff -r b73d6668eba3 -r ac6408084c60 .gitignore
--- 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/**
diff -r b73d6668eba3 -r ac6408084c60 doc/about.rst
--- /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
+
diff -r b73d6668eba3 -r ac6408084c60 doc/index.rst
--- 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