equal
deleted
inserted
replaced
23 |
23 |
24 ## Tutorials and examples ## |
24 ## Tutorials and examples ## |
25 |
25 |
26 In IDE, find menu "File>Tutorials and examples" to quickly open examples that should run as-is. |
26 In IDE, find menu "File>Tutorials and examples" to quickly open examples that should run as-is. |
27 |
27 |
28 There are more examples in 'tests/projects' and 'exemples' directories. |
28 There are more examples in `tests/projects` and `exemples` directories. |
29 |
29 |
30 Some example and test are shown on [Beremiz youtube channel](https://www.youtube.com/channel/UCcE4KYI0p1f6CmSwtzyg-ZA). |
30 Some example and test are shown on [Beremiz youtube channel](https://www.youtube.com/channel/UCcE4KYI0p1f6CmSwtzyg-ZA). |
31 |
31 |
32 ## Development with Beremiz ## |
32 ## Development with Beremiz ## |
33 |
33 |
69 |
69 |
70 ``` |
70 ``` |
71 |
71 |
72 ### Prepare build directory |
72 ### Prepare build directory |
73 |
73 |
74 All commands hereafter assume that selected directory to contain all downloaded source code and build results is '~/Beremiz' |
74 All commands hereafter assume that selected directory to contain all downloaded source code and build results is `~/Beremiz` |
75 |
75 |
76 ``` |
76 ``` |
77 mkdir ~/Beremiz |
77 mkdir ~/Beremiz |
78 cd ~/Beremiz |
78 cd ~/Beremiz |
79 ``` |
79 ``` |
103 make |
103 make |
104 ``` |
104 ``` |
105 |
105 |
106 ### Build CanFestival (optional) |
106 ### Build CanFestival (optional) |
107 |
107 |
108 Only needed for CANopen support. Please read CanFestival manual to choose CAN interface other than 'virtual'. |
108 Only needed for CANopen support. Please read CanFestival manual to choose CAN interface other than `virtual`. |
109 |
109 |
110 ``` |
110 ``` |
111 cd ~/Beremiz |
111 cd ~/Beremiz |
112 hg clone http://hg.beremiz.org/CanFestival-3 |
112 hg clone http://hg.beremiz.org/CanFestival-3 |
113 cd ~/Beremiz/CanFestival-3 |
113 cd ~/Beremiz/CanFestival-3 |
161 |
161 |
162 If project's URL is 'LOCAL://', then IDE launches on demand a local instance of Beremiz python runtime working on a temporary directory. |
162 If project's URL is 'LOCAL://', then IDE launches on demand a local instance of Beremiz python runtime working on a temporary directory. |
163 |
163 |
164 ## Build documentation |
164 ## Build documentation |
165 |
165 |
166 Source code for documentation is stored in [doc](tree/default/doc) directory in project's source tree. |
166 Source code for documentation is stored in `doc` directory in project's source tree. |
167 It's written in reStructuredText (ReST) and uses Sphinx to generate documentation in different formats. |
167 It's written in reStructuredText (ReST) and uses Sphinx to generate documentation in different formats. |
168 |
168 |
169 To build documentation you need following packages on Ubuntu/Debian: |
169 To build documentation you need following packages on Ubuntu/Debian: |
170 |
170 |
171 ``` |
171 ``` |
180 cd ~/Beremiz/doc |
180 cd ~/Beremiz/doc |
181 make all |
181 make all |
182 |
182 |
183 ``` |
183 ``` |
184 |
184 |
185 Result documentation is stored in directories 'doc/\_build/dirhtml\*'. |
185 Result documentation is stored in directories `doc/_build/dirhtml*`. |
186 |
186 |
187 ### Documentation in PDF |
187 ### Documentation in PDF |
188 |
188 |
189 To build pdf documentation you have to install additional packages on Ubuntu/Debian: |
189 To build pdf documentation you have to install additional packages on Ubuntu/Debian: |
190 |
190 |
200 cd ~/Beremiz/doc |
200 cd ~/Beremiz/doc |
201 make latexpdf |
201 make latexpdf |
202 |
202 |
203 ``` |
203 ``` |
204 |
204 |
205 Result documentation is stored in 'doc/\_build/latex/Beremiz.pdf'. |
205 Result documentation is stored in `doc/_build/latex/Beremiz.pdf`. |
206 |
206 |
207 ## Documentation ## |
207 ## Documentation ## |
208 |
208 |
209 * See [Beremiz youtube channel](https://www.youtube.com/channel/UCcE4KYI0p1f6CmSwtzyg-ZA) to get quick information how to use Beremiz IDE. |
209 * See [Beremiz youtube channel](https://www.youtube.com/channel/UCcE4KYI0p1f6CmSwtzyg-ZA) to get quick information how to use Beremiz IDE. |
210 |
210 |