diff --git a/FEATURES.md b/FEATURES.md index f7c7ae8c..e5f85c4e 100644 --- a/FEATURES.md +++ b/FEATURES.md @@ -21,7 +21,7 @@ vim: spelllang=en spell - Supports any realtime environment through independent architecture. - 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. - 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. - 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. - Setting the master's debug level. - Reading/Writing alias addresses. diff --git a/INSTALL.md b/INSTALL.md index 33029117..a4aa2766 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -6,7 +6,7 @@ vim: set spelllang=en spell tw=78 The complete build and installation procedure is described in the respective 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 ``` -Have a look at the examples/ subdirectory for some application examples. +Have a look at the [examples subdirectory](examples/) for some application +examples. --- diff --git a/README.md b/README.md index c622374f..b16a75b3 100644 --- a/README.md +++ b/README.md @@ -14,16 +14,16 @@ Contents: 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. or contact -Dipl.-Ing. (FH) Florian Pose -Ingenieurgemeinschaft IgH -Nordsternstraße 66 -D-45329 Essen -http://igh.de +> Dipl.-Ing. (FH) Florian Pose +> Ingenieurgemeinschaft IgH +> Nordsternstraße 66 +> D-45329 Essen +> http://igh.de # Documentation @@ -37,12 +37,10 @@ cd documentation make ``` -The PDF is automatically generated automatically in GitLab and can be -downloaded -[https://gitlab.com/etherlab.org/ethercat/-/jobs/artifacts/stable-1.5/raw/pdf/ethercat_doc.pdf?job=pdf](from -here). +The PDF is automatically held up-to-date and can be [downloaded from +GitLab](https://gitlab.com/etherlab.org/ethercat/-/jobs/artifacts/stable-1.5/raw/pdf/ethercat_doc.pdf?job=pdf). -## Dogygen +## Doxygen To generate the Doxygen documentation, the following commands can be used. 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 -[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