README.md
author Edouard Tisserant
Tue, 30 Oct 2018 09:46:46 +0100
changeset 2326 d42ae2877b6e
parent 2292 7c34d6f9d59b
child 2495 016748ef5fc4
permissions -rw-r--r--
WAMP : ensure that unicode string is passed for published events IDs
1728
9a2d192a7aef fix link to documentation in README.md
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1727
diff changeset
     1
[![docs](https://readthedocs.org/projects/beremiz/badge/?version=latest)](https://beremiz.readthedocs.io)
1727
865e157c6474 Add information about built official documentation to README.md
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1679
diff changeset
     2
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
     3
# Beremiz #
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
     4
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
     5
Beremiz is an integrated development environment for machine automation. It is Free Software, conforming to IEC-61131 among other standards.
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
     6
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
     7
It relies on open standards to be independent of the targeted device, and let you turn any processor into a PLC. Beremiz includes tools to create HMI, and to connect your PLC programs to existing supervisions, databases, or fieldbuses.
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
     8
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
     9
With Beremiz, you conform to standards, avoid vendor lock, and contribute to the better future of Automation. 
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    10
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    11
Beremiz consists of two components:
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    12
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    13
* Integrated Development Environment (IDE), [Beremiz.py](https://bitbucket.org/automforge/beremiz/src/tip/Beremiz.py?at=default). It's running on user's computer and is used to write/compile/debug PLC programs and control PLC runtime.
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    14
* Reference runtime implementation in python, [Beremiz_service.py](https://bitbucket.org/automforge/beremiz/src/tip/Beremiz_service.py?at=default). It's running on target platform, communicates with I/O and executes PLC program.
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    15
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    16
See official [Beremiz website](http://www.beremiz.org/) for more information.
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    17
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    18
## Build on Linux ##
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    19
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    20
* Prerequisites
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    21
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    22
		# Ubuntu/Debian :
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    23
		sudo apt-get install build-essential bison flex autoconf
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    24
		sudo apt-get install python-wxgtk3.0 pyro mercurial
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    25
		sudo apt-get install python-nevow python-matplotlib python-lxml python-zeroconf python-cycler
2292
7c34d6f9d59b Update requirements to include WAMP support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2276
diff changeset
    26
		sudo apt-get install python-autobahn python-u-msgpack
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    27
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    28
* Prepare
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    29
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    30
		mkdir ~/Beremiz
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    31
		cd ~/Beremiz
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    32
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    33
* Get Source Code
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    34
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    35
		cd ~/Beremiz
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    36
		hg clone https://bitbucket.org/skvorl/beremiz
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    37
		hg clone https://bitbucket.org/mjsousa/matiec
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    38
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    39
* Build MatIEC compiler
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    40
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    41
		cd ~/Beremiz/matiec
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    42
		autoreconf -i
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    43
		./configure
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    44
		make
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    45
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    46
* Build CanFestival (optional)  
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    47
  Only needed for CANopen support. Please read CanFestival manual to choose CAN interface other than 'virtual'.
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    48
2276
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    49
		cd ~/Beremiz
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    50
		hg clone http://dev.automforge.net/CanFestival-3
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    51
		cd ~/Beremiz/CanFestival-3
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    52
		./configure --can=virtual
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    53
		make
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    54
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    55
* Build Modbus library (optional)
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    56
  Only needed for Modbus support.
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    57
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    58
		cd ~/Beremiz
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    59
		hg clone https://bitbucket.org/mjsousa/modbus Modbus
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    60
		cd ~/Beremiz/Modbus
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    61
		make
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    62
2276
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    63
* Build BACnet (optional)
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    64
  Only needed for BACnet support.
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    65
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    66
		cd ~/Beremiz
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    67
		svn checkout https://svn.code.sf.net/p/bacnet/code/trunk/bacnet-stack/ BACnet
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    68
		cd BACnet
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    69
		make MAKE_DEFINE='-fPIC' all
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    70
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    71
* Launch Beremiz IDE
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    72
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    73
		cd ~/Beremiz/beremiz
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    74
		python Beremiz.py
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    75
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    76
## Run standalone Beremiz runtime ##
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    77
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    78
Runtime implementation can be different on different platforms.
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    79
For example, PLC used Cortex-M most likely would have C-based runtime. Beremiz project contains reference implementation in python, that can be easily run on GNU/Linux, Windows and Mac OS X.
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    80
This section will describe how to run it.
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    81
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    82
If project's URL is 'LOCAL://', then IDE launches temprorary instance of Beremiz python runtime (Beremiz_service.py) localy as user tries to connect to PLC. This allows to debug programs localy without PLC.
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    83
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    84
If you want to run Beremiz_service.py as standalone service, then follow these instructions:
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    85
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    86
* Start standalone Beremiz service
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    87
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    88
		cd ~/Beremiz
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    89
		mkdir beremiz_workdir
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    90
		cd ~/beremiz
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    91
		python Beremiz_service.py -p 61194 -i localhost -x 0 -a 1 ~/Beremiz/beremiz_workdir
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    92
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    93
* Launch Beremiz IDE
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    94
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    95
		cd ~/Beremiz/beremiz
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    96
		python Beremiz.py
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    97
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    98
* Open/Create PLC project in Beremiz IDE.  
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    99
  Enter target location URI in project's settings (project->Config->BeremizRoot/URI_location) pointed to your running Beremiz service (For example, PYRO://127.0.0.1:61194).
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   100
  Save project and connect to running Beremiz service.
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   101
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   102
## Examples ##
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   103
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   104
Almost for all functionality exists example in ['tests'](https://bitbucket.org/automforge/beremiz/src/tip/tests/?at=default) directory.
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   105
Most of examples are shown on [Beremiz youtube channel](https://www.youtube.com/channel/UCcE4KYI0p1f6CmSwtzyg-ZA).
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   106
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   107
## Documentation ##
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   108
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   109
 * See [Beremiz youtube channel](https://www.youtube.com/channel/UCcE4KYI0p1f6CmSwtzyg-ZA) to get quick information how to use Beremiz IDE.
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   110
 
1729
31e63e25b4cc README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1728
diff changeset
   111
 * [Official user manual](http://beremiz.readthedocs.io/) is built from sources in doc directory.
31e63e25b4cc README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1728
diff changeset
   112
   Documentation does not cover all aspects of Beremiz use yet.
31e63e25b4cc README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1728
diff changeset
   113
   Contribution are very welcome!
1727
865e157c6474 Add information about built official documentation to README.md
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1679
diff changeset
   114
   
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   115
 * [User manual](http://www.sm1820.ru/files/beremiz/beremiz_manual.pdf) from INEUM (Russian).
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   116
   Be aware that it contains some information about functions available only in INEUM's fork of Beremiz.
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   117
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   118
 * [User manual](http://www.beremiz.org/LpcManager_UserManual.pdf) from Smarteh (English).
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   119
   Be aware that it contains some information about functions available only in Smarteh's fork of Beremiz.
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   120
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   121
 * Outdated short [user manual](https://www.scribd.com/document/76101511/Manual-Beremiz#scribd) from LOLI Tech (English).
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   122
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   123
 * See official [Beremiz website](http://www.beremiz.org/) for more information.
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   124
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   125
## Support and development ##
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   126
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   127
Main community support channel is [mailing list](https://sourceforge.net/p/beremiz/mailman/beremiz-devel/) (beremiz-devel@lists.sourceforge.net).
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   128
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   129
The list is moderated and requires subscription for posting to it.
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   130
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   131
To subscribe to the mailing list go [here](https://sourceforge.net/p/beremiz/mailman/beremiz-devel/).
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   132
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   133
Searchable archive using search engine of your choice is available [here](http://beremiz-devel.2374573.n4.nabble.com/).