README.md
author Edouard Tisserant <edouard.tisserant@gmail.com>
Thu, 10 Nov 2022 19:36:30 +0100
branchwxPython4
changeset 3669 ca25c686cd97
parent 3638 606c984a58c2
child 3835 5b65b8f6d523
permissions -rw-r--r--
Tests: UI tests can now load projects from tests/projects
3635
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
     1
<!---
1728
9a2d192a7aef fix link to documentation in README.md
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1727
diff changeset
     2
[![docs](https://readthedocs.org/projects/beremiz/badge/?version=latest)](https://beremiz.readthedocs.io)
3635
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
     3
-->
1727
865e157c6474 Add information about built official documentation to README.md
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1679
diff changeset
     4
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
     5
# Beremiz #
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
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
     8
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
     9
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
    10
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    11
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
    12
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
    13
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
    14
3450
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    15
* Integrated Development Environment (IDE), Beremiz.py. It is running on user's computer and is used to write/compile/debug PLC programs and control PLC runtime.
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    16
* Reference runtime implementation in python, Beremiz_service.py. It's running on target platform, communicates with I/O and executes PLC program.
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
    17
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    18
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
    19
3635
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    20
## Install latest release ##
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    21
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    22
Windows installer and Snap package for Linux are available in [Github releases](https://github.com/beremiz/beremiz/releases) and [Snapcraft's store](https://snapcraft.io/beremiz)
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    23
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    24
## Tutorials and examples ##
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    25
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    26
In IDE, find menu "File>Tutorials and examples" to quickly open examples that should run as-is.
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    27
3637
08a078a04f95 Update README.md
etisserant <edouard.tisserant@gmail.com>
parents: 3635
diff changeset
    28
There are more examples in `tests/projects` and `exemples` directories.
3635
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    29
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    30
Some example and test are shown on [Beremiz youtube channel](https://www.youtube.com/channel/UCcE4KYI0p1f6CmSwtzyg-ZA).
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    31
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    32
## Development with Beremiz ##
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    33
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    34
Developers are invited to subscribe to [mailing list](https://sourceforge.net/p/beremiz/mailman/beremiz-devel/) (beremiz-devel@lists.sourceforge.net).
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    35
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    36
The list is moderated and requires subscription before posting.
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    37
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    38
To subscribe to the mailing list go [here](https://sourceforge.net/p/beremiz/mailman/beremiz-devel/).
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    39
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    40
Searchable archive using search engine of your choice is available [here](http://beremiz-devel.2374573.n4.nabble.com/).
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    41
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    42
## Build on Linux (developer setup) ##
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    43
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    44
### Prerequisites (Ubuntu/Debian) :
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    45
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    46
sudo apt-get install build-essential bison flex autoconf
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    47
sudo apt-get install python2-dev libpython2.7-dev libgtk-3-dev libssl-dev libgl1-mesa-dev libglu1-mesa-dev python-setuptools
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    48
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    49
python2 -m pip install  \
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    50
    future              \
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    51
    matplotlib          \
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    52
    msgpack_python      \
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    53
    u-msgpack-python    \
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    54
    zeroconf2           \
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    55
    enum34              \
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    56
    pyro                \
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    57
    sslpsk              \
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    58
    posix_spawn         \
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    59
    twisted             \
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    60
    nevow               \
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    61
    autobahn            \
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    62
    click               \
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    63
    opcua               \
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    64
    pycountry           \
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    65
    fonttools           \
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    66
    Brotli              \
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    67
    lxml==4.5.0         \
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    68
    wxPython==4.1.1
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    69
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    70
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    71
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    72
### Prepare build directory
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    73
3637
08a078a04f95 Update README.md
etisserant <edouard.tisserant@gmail.com>
parents: 3635
diff changeset
    74
All commands hereafter assume that selected directory to contain all downloaded source code and build results is `~/Beremiz`
3635
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    75
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    76
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    77
mkdir ~/Beremiz
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    78
cd ~/Beremiz
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    79
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    80
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    81
### Get Source Code (Mercurial)
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    82
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    83
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    84
cd ~/Beremiz
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    85
hg clone https://hg.beremiz.org/beremiz
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    86
hg clone https://hg.beremiz.org/matiec
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    87
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    88
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    89
### Get Source Code (Git)
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    90
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    91
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    92
cd ~/Beremiz
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    93
git clone https://github.com/beremiz/beremiz
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    94
git clone https://github.com/beremiz/matiec
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    95
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    96
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    97
### Build MatIEC compiler
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    98
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
    99
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   100
cd ~/Beremiz/matiec
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   101
autoreconf -i
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   102
./configure
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   103
make
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   104
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   105
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   106
### Build CanFestival (optional)
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   107
3637
08a078a04f95 Update README.md
etisserant <edouard.tisserant@gmail.com>
parents: 3635
diff changeset
   108
Only needed for CANopen support. Please read CanFestival manual to choose CAN interface other than `virtual`.
3635
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   109
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   110
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   111
cd ~/Beremiz
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   112
hg clone http://hg.beremiz.org/CanFestival-3
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   113
cd ~/Beremiz/CanFestival-3
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   114
./configure --can=virtual
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   115
make
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   116
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   117
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   118
### Build Modbus library (optional)
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   119
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   120
Only needed for Modbus support.
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   121
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   122
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   123
cd ~/Beremiz
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   124
hg clone https://hg.beremiz.org/Modbus
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   125
cd ~/Beremiz/Modbus
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   126
make
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   127
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   128
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   129
### Build BACnet (optional)
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   130
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   131
Only needed for BACnet support.
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   132
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   133
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   134
cd ~/Beremiz
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   135
svn checkout https://svn.code.sf.net/p/bacnet/code/trunk/bacnet-stack/ BACnet
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   136
cd BACnet
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   137
make MAKE_DEFINE='-fPIC' MY_BACNET_DEFINES='-DPRINT_ENABLED=1 -DBACAPP_ALL -DBACFILE -DINTRINSIC_REPORTING -DBACNET_TIME_MASTER -DBACNET_PROPERTY_LISTS=1 -DBACNET_PROTOCOL_REVISION=16' library
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   138
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   139
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   140
### Launch Beremiz IDE
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   141
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   142
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   143
cd ~/Beremiz/beremiz
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   144
python Beremiz.py
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   145
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   146
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   147
## Run standalone Beremiz runtime ##
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   148
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   149
* Start standalone Beremiz service
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   150
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   151
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   152
mkdir ~/beremiz_runtime_workdir
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   153
python Beremiz_service.py -p 61194 -i localhost -x 0 -a 1 ~/beremiz_runtime_workdir
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   154
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   155
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   156
To connect IDE with runtime, enter target location URI in project's settings (project->Config->BeremizRoot/URI_location) pointed to your running Beremiz service in this case :
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   157
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   158
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   159
PYRO://127.0.0.1:61194
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   160
```
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   161
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   162
If project's URL is 'LOCAL://', then IDE launches on demand a local instance of Beremiz python runtime working on a temporary directory.
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   163
3450
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   164
## Build documentation
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   165
3637
08a078a04f95 Update README.md
etisserant <edouard.tisserant@gmail.com>
parents: 3635
diff changeset
   166
Source code for documentation is stored in `doc` directory in project's source tree.
3635
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   167
It's written in reStructuredText (ReST) and uses Sphinx to generate documentation in different formats.
3450
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   168
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   169
To build documentation you need following packages on Ubuntu/Debian:
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   170
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   171
```
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   172
sudo apt-get install build-essential python-sphynx
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   173
```
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   174
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   175
### Documentation in HTML
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   176
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   177
Build documentation
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   178
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   179
```
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   180
cd ~/Beremiz/doc
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   181
make all
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   182
```
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   183
3637
08a078a04f95 Update README.md
etisserant <edouard.tisserant@gmail.com>
parents: 3635
diff changeset
   184
Result documentation is stored in directories `doc/_build/dirhtml*`.
3450
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   185
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   186
### Documentation in PDF
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   187
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   188
To build pdf documentation you have to install additional packages on Ubuntu/Debian:
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   189
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   190
```
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   191
sudo apt-get install textlive-latex-base texlive-latex-recommended \
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   192
     texlive-fonts-recommended texlive-latex-extra
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   193
```
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   194
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   195
Build documentation
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   196
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   197
```
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   198
cd ~/Beremiz/doc
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   199
make latexpdf
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   200
```
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   201
3637
08a078a04f95 Update README.md
etisserant <edouard.tisserant@gmail.com>
parents: 3635
diff changeset
   202
Result documentation is stored in `doc/_build/latex/Beremiz.pdf`.
3450
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   203
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
   204
## Documentation ##
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   205
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   206
 * See [Beremiz youtube channel](https://www.youtube.com/channel/UCcE4KYI0p1f6CmSwtzyg-ZA) to get quick information how to use Beremiz IDE.
3605
7aa4209c2b2d update installation instructions
v.petrov <v.petrov@k-soft-spb.ru>
parents: 3450
diff changeset
   207
3635
5107a2712b17 Update README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3606
diff changeset
   208
 * [Official documentation](http://beremiz.readthedocs.io/) is built from sources in doc directory.
1729
31e63e25b4cc README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1728
diff changeset
   209
   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
   210
   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
   211
   
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   212
 * [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
   213
   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
   214
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   215
 * [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
   216
   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
   217
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   218
 * 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
   219
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   220
 * 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
   221