bkinnightskytw
/
ethercat
mirror of https://gitlab.com/bkinnightskytw/ethercat.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Markdown fixes.

This commit is contained in:
Florian Pose 2023-01-30 10:45:31 +01:00
parent d8045fe122
commit d34e5a60d4
3 changed files with 15 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
FEATURES.md
View File

@ -21,7 +21,7 @@ vim: spelllang=en spell
- Supports any realtime environment through independent architecture. - Supports any realtime environment through independent architecture.
- RTAI, Xenomai, RT-Preempt, etc. - RTAI, Xenomai, RT-Preempt, etc.
- RTDM Interface for userspace realtime enviroments - RTDM Interface for userspace realtime environments
- Operation possible without any realtime extension at all. - Operation possible without any realtime extension at all.
- Common API for Realtime-Applications in kernel- and userspace. - Common API for Realtime-Applications in kernel- and userspace.
@ -66,7 +66,7 @@ vim: spelllang=en spell
- Loading and storing files via the command-line tool. - Loading and storing files via the command-line tool.
- Updating a slave's firmware can be done easily. - Updating a slave's firmware can be done easily.
- Userspace command-line tool 'ethercat'. - Userspace command-line tool `ethercat`.
- Detailed information about master, slaves, domains and bus configuration. - Detailed information about master, slaves, domains and bus configuration.
- Setting the master's debug level. - Setting the master's debug level.
- Reading/Writing alias addresses. - Reading/Writing alias addresses.

5
INSTALL.md
View File

@ -6,7 +6,7 @@ vim: set spelllang=en spell tw=78
The complete build and installation procedure is described in the respective The complete build and installation procedure is described in the respective
section of the section of the
[https://gitlab.com/etherlab.org/ethercat/-/jobs/artifacts/stable-1.5/raw/pdf/ethercat_doc.pdf?job=pdf](documentation). [documentation](https://gitlab.com/etherlab.org/ethercat/-/jobs/artifacts/stable-1.5/raw/pdf/ethercat_doc.pdf?job=pdf).
--- ---
@ -50,7 +50,8 @@ Now you can start the EtherCAT master:
/etc/init.d/ethercat start /etc/init.d/ethercat start
``` ```
Have a look at the examples/ subdirectory for some application examples. Have a look at the [examples subdirectory](examples/) for some application
examples.
--- ---

22
README.md
View File

@ -14,16 +14,16 @@ Contents:
This is an open-source EtherCAT master implementation for Linux 2.6 or newer. This is an open-source EtherCAT master implementation for Linux 2.6 or newer.
See the (Features file)[FEATURES] for a list of features. For more See the [features file](FEATURES.md) for a list of features. For more
information, see http://etherlab.org/en/ethercat. information, see http://etherlab.org/en/ethercat.
or contact or contact
Dipl.-Ing. (FH) Florian Pose <fp@igh.de> > Dipl.-Ing. (FH) Florian Pose <fp@igh.de>
Ingenieurgemeinschaft IgH > Ingenieurgemeinschaft IgH
Nordsternstraße 66 > Nordsternstraße 66
D-45329 Essen > D-45329 Essen
http://igh.de > http://igh.de
# Documentation # Documentation
@ -37,12 +37,10 @@ cd documentation
make make
``` ```
The PDF is automatically generated automatically in GitLab and can be The PDF is automatically held up-to-date and can be [downloaded from
downloaded GitLab](https://gitlab.com/etherlab.org/ethercat/-/jobs/artifacts/stable-1.5/raw/pdf/ethercat_doc.pdf?job=pdf).
[https://gitlab.com/etherlab.org/ethercat/-/jobs/artifacts/stable-1.5/raw/pdf/ethercat_doc.pdf?job=pdf](from
here).
## Dogygen ## Doxygen
To generate the Doxygen documentation, the following commands can be used. To generate the Doxygen documentation, the following commands can be used.
Therefore, the configure script must have run (see the [install Therefore, the configure script must have run (see the [install
@ -54,7 +52,7 @@ make doc
``` ```
An up-to-date Doxygen output can be found on An up-to-date Doxygen output can be found on
[https://docs.etherlab.org/ethercat/1.5/doxygen/index.html](docs.etherlab.org). [docs.etherlab.org](https://docs.etherlab.org/ethercat/1.5/doxygen/index.html).
# Requirements # Requirements