chore: catchup to 7b6853b

7b6853b docs: update main readme file
5d556a3 docs: add release notes
eaa4f38 docs: Fix spelling
c76aafa docs: Add instructions for spell checking
3701d6b docs: Add words to spelling wordlist
1f7773e docs: Switch to British spelling
f2e1f22 docs: Switch to internal Kroki server
17dff3d docs: Move content to new chapter
eb98351 chore: update version to 1.0.0
e9aee0b feat: add github evaluation readme

Based-On-Commit: 7b6853b4c3f1b4768749933887007f68e4078e05
Change-Id: If21d4765d91ecc45e5b888597d83497c97d2c6e0

Author: rt-labs bot

.github/README.md

@@ -0,0 +1,17 @@
+# Evaluation version
+
+This repository contains an evaluation version the M-Bus Modbus stack.
+The stack is written to an OS abstraction layer and can also be used
+in a bare metal application. Using the abstraction layer, the stack
+can run on Linux, Windows or on an RTOS.
+
+It does not contain complete ports and cannot be built without adding additional sources.
+
+See [readme](../../README.md) for more information on the complete version of
+the stack and the [releases](https://github.com/rtlabs-com/m-bus/releases)
+for binary downloads for common targets.
+
+This version of M-Bus can be used for evaluation purposes
+only. Contact [email protected] if you intend to use this stack in a
+product or if you need assistance during evaluation. The commercial
+version of this stack is supplied with full sources.

README.md

@@ -1,39 +1,58 @@
 Modbus stack
 =============
-[![Build Status](https://github.com/rtlabs-com/m-bus/workflows/Build/badge.svg?branch=master)](https://github.com/rtlabs-com/m-bus/actions?workflow=Build)
-[![CodeQL](https://github.com/rtlabs-com/m-bus/workflows/CodeQL/badge.svg?branch=master)](https://github.com/rtlabs-com/m-bus/actions?workflow=CodeQL)
 
 This repository contains the M-Bus Modbus stack. The stack is written to an OS
 abstraction layer and can also be used in a bare metal
 application. Using the abstraction layer, the stack can run on Linux,
 Windows or on an RTOS.
 
-Cloning
-=======
+Web resources
+-------------
 
-Clone the source:
+* Source repository: [https://github.com/rtlabs-com/m-bus](https://github.com/rtlabs-com/m-bus)
+* Documentation: [https://rt-labs.com/docs/m-bus](https://rt-labs.com/docs/m-bus)
+* RT-Labs (stack integration, certification services and training): [https://rt-labs.com](https://rt-labs.com)
 
-```
-$ git clone --recurse-submodules https://github.com/rtlabs-com/m-bus.git
-```
+Features
+--------
 
-This will clone the repository with submodules. If you already cloned
-the repository without the `--recurse-submodules` flag then run this
-in the `m-bus` folder:
+* Modbus master (client)
+* Modbus slave (server)
+* Modbus TCP
+* Modbus RTU
+* All four primary tables (coils, inputs, holding registers, input registers)
+* Vendor-defined function codes
+* Diagnostics
+* Implemented in C, supports C++
+* Ports available for Linux, Windows (Modbus TCP only) and RT-Kernel
+* Porting layer allows extending the stack to new ports
 
-```
-$ git submodule update --init --recursive
-```
+License
+-------
 
-Building
-========
+This software is dual-licensed, with GPL version 3 and a commercial license. See
+LICENSE.md for more details.
+
+Requirements
+------------
+
+cmake
+
+* cmake 3.28 or later
+
+For Linux:
+
+* gcc 4.6 or later
+
+For rt-kernel:
+
+* Workbench 2018.1 or later
 
-See the [manual](https://docs.rt-labs.com/m-bus/).
 
 Contributions
-=============
+-------------
 
-Contributions are welcome. If you want to contribute you will need to
-sign a Contributor License Agreement and send it to us either by
-e-mail or by physical mail. More information is available
-[here](https://rt-labs.com/contribution).
+Contributions are welcome. If you want to contribute you will need to sign a
+Contributor License Agreement and send it to us either by e-mail or by physical
+mail. More information is available
+on [https://rt-labs.com/contribution](https://rt-labs.com/contribution).

include/mbus.h

@@ -283,7 +283,7 @@ MB_EXPORT int mbus_read (
  * \param slave         Slave handle. See mbus_connect()
  * \param address       1-based starting address. May be constructed
  *                      by calling MB_ADDRESS(). Note that only coils and
- *                      holding registers are writeable.
+ *                      holding registers are writable.
  * \param quantity      Number of addresses to write. Valid range is 1 - 1968
  *                      for coils and 1 - 123 for holding registers
  * \param buffer        Input buffer
@@ -328,7 +328,7 @@ MB_EXPORT int mbus_write (
  * \param slave         Slave handle. See mbus_connect()
  * \param address       1-based address to be written to. May be constructed
  *                      by calling MB_ADDRESS(). Note that only coils and
- *                      holding registers are writeable.
+ *                      holding registers are writable.
  * \param value         The value to be written
  *
  * \return 0 on success, error code otherwise

sample/ports/linux/tcp_rtu_master.c

@@ -54,7 +54,7 @@ static void help (const char * name)
    printf (
       "Read/write Modbus registers\n"
       "\n"
-      "This purpose of this program is to demonstrate use of the m-bus\n"
+      "This purpose of this program is to demonstrate use of the M-Bus\n"
       "Modbus master stack. It may also be useful as a debugging tool.\n"
       "\n"
       "USAGE:\n"

sample/ports/windows/tcp_rtu_master.c

@@ -54,7 +54,7 @@ static void help (const char * name)
    printf (
       "Read/write Modbus registers\n"
       "\n"
-      "This purpose of this program is to demonstrate use of the m-bus\n"
+      "This purpose of this program is to demonstrate use of the M-Bus\n"
       "Modbus master stack. It may also be useful as a debugging tool.\n"
       "\n"
       "USAGE:\n"