# HG changeset patch # User etisserant # Date 1666282227 -7200 # Node ID 08a078a04f954514d054ca67257a322dbceb323e # Parent 99b20dff00d5cf6d14d80d8f30015c66fce281cb Update README.md use back quote instead of simple quote for quoted strings. diff -r 99b20dff00d5 -r 08a078a04f95 README.md --- a/README.md Wed Oct 19 22:04:39 2022 +0200 +++ b/README.md Thu Oct 20 18:10:27 2022 +0200 @@ -25,7 +25,7 @@ In IDE, find menu "File>Tutorials and examples" to quickly open examples that should run as-is. -There are more examples in 'tests/projects' and 'exemples' directories. +There are more examples in `tests/projects` and `exemples` directories. Some example and test are shown on [Beremiz youtube channel](https://www.youtube.com/channel/UCcE4KYI0p1f6CmSwtzyg-ZA). @@ -71,7 +71,7 @@ ### Prepare build directory -All commands hereafter assume that selected directory to contain all downloaded source code and build results is '~/Beremiz' +All commands hereafter assume that selected directory to contain all downloaded source code and build results is `~/Beremiz` ``` mkdir ~/Beremiz @@ -105,7 +105,7 @@ ### Build CanFestival (optional) -Only needed for CANopen support. Please read CanFestival manual to choose CAN interface other than 'virtual'. +Only needed for CANopen support. Please read CanFestival manual to choose CAN interface other than `virtual`. ``` cd ~/Beremiz @@ -163,7 +163,7 @@ ## Build documentation -Source code for documentation is stored in [doc](tree/default/doc) directory in project's source tree. +Source code for documentation is stored in `doc` directory in project's source tree. It's written in reStructuredText (ReST) and uses Sphinx to generate documentation in different formats. To build documentation you need following packages on Ubuntu/Debian: @@ -182,7 +182,7 @@ ``` -Result documentation is stored in directories 'doc/\_build/dirhtml\*'. +Result documentation is stored in directories `doc/_build/dirhtml*`. ### Documentation in PDF @@ -202,7 +202,7 @@ ``` -Result documentation is stored in 'doc/\_build/latex/Beremiz.pdf'. +Result documentation is stored in `doc/_build/latex/Beremiz.pdf`. ## Documentation ##