Fix timing bugs and add documentation

[m17rt] / README.TXT

diff --git a/README.TXT b/README.TXT
index 27d42311ea2d34e61e92fb23e9fb9e2b9baa8106..302b3e68387a9f1f9606d2813b1b07789ba2e988 100644 (file)
--- a/README.TXT
+++ b/README.TXT
@@ -2,26 +2,24 @@
  M17 RUST TOOLKIT
 ==================
 
  M17 RUST TOOLKIT
 ==================
 

-As of Dec 2024 this software is still under active development. The description that follows is not fully implemented yet.
-

 M17RT is a collection of Rust crates and utilities to make it as easy to possible to implement programs that use the M17
 M17RT is a collection of Rust crates and utilities to make it as easy to possible to implement programs that use the M17

-Protocol for amateur radio: <https://m17foundation.org/projects/>.
+Protocol for amateur radio: <https://m17project.org/>.

 
 
 
 

-                        ┌──────────────────────────────────────┐   <.
-                   .>   │ m17app                               │    | Fan in data from adapters to TNC
+                        ┌──────────────────────────────────────┐   <-
+                   ->   │ m17app                               │    | Fan in data from adapters to TNC

  High level API    |    │ - High-level API for packets/streams │    | Fan out data from radio to adapters
  High level API    |    │ - High-level API for packets/streams │    | Fan out data from radio to adapters

- For PC-based apps |    │ - Sound card integration             │   <.
+ For PC-based apps |    │ - Sound card integration             │   <-

                    |    │ - TCP client/server KISS             │         vv KISS ^^
                    |    │ - TCP client/server KISS             │         vv KISS ^^

-                   .>   │ - Multithreading                     │   <.
+                   ->   │ - Multithreading                     │   <-

                         └──────────────────────────────────────┘    | Soundmodem worker thread:
                                                                     | Takes a sound card, PTT,
                         ┌──────────────────────────────────────┐    | assembles the components
                         └──────────────────────────────────────┘    | Soundmodem worker thread:
                                                                     | Takes a sound card, PTT,
                         ┌──────────────────────────────────────┐    | assembles the components

-                   .>   │ m17core                              │    | from m17core and puts it
+                   ->   │ m17core                              │    | from m17core and puts it

  Low level API     |    │ - M17 KISS protocol                  │    | behind a KISS interface.
  no_std, no heap   |    │ - TNC / CSMA                         │    |
  could be no-float |    │ - M17 Data Link                      │    |
  Low level API     |    │ - M17 KISS protocol                  │    | behind a KISS interface.
  no_std, no heap   |    │ - TNC / CSMA                         │    |
  could be no-float |    │ - M17 Data Link                      │    |

-                   .>   │ - Baseband Modem                     │   <.
+                   ->   │ - Baseband Modem                     │   <-

                         └──────────────────────────────────────┘
 
 
                         └──────────────────────────────────────┘
 
 


@@ -36,16 +34,16 @@ a KISS TNC, including M17 applications that do not use this toolkit or are not w
 The basic structure of a program is that you will configure your TNC, use it to initialise an M17App, then add adapters to
 the M17App which will handle all or a subset of the traffic. They will all share the same TNC.
 
 The basic structure of a program is that you will configure your TNC, use it to initialise an M17App, then add adapters to
 the M17App which will handle all or a subset of the traffic. They will all share the same TNC.
 

-Codec2 support follows the same pattern - the m17codec2 crate will provide standard M17App stream adapters to handle both:
-    mic -> encode -> transmit stream
-    incoming stream -> decode -> output on sound card
+Codec2 support follows the same pattern - the m17codec2 crate provides standard M17App stream adapters to handle both:
+    human speech audio -> encode -> transmit stream
+    incoming M17 stream -> decode -> output on sound card

 
 Splitting this into a separate crate serves two purposes. This reduces the dependency count if your app does not actually
 use codec2. It also means you can avoid statically linking LGPL code into your Rust binary if you are relying on M17RT's
 permissive licence. In this situation you can probably still find a way to use codec2 but it's not going to be as simple
 as putting this in your Cargo.toml since Rust makes dynamic linking difficult.
 
 
 Splitting this into a separate crate serves two purposes. This reduces the dependency count if your app does not actually
 use codec2. It also means you can avoid statically linking LGPL code into your Rust binary if you are relying on M17RT's
 permissive licence. In this situation you can probably still find a way to use codec2 but it's not going to be as simple
 as putting this in your Cargo.toml since Rust makes dynamic linking difficult.
 

-Finally, there will be a series of utility binaries for modulation, demodulation, creating a KISS TCP server, etc. These
+Finally, there is a series of utility binaries for modulation, demodulation, creating a KISS TCP server, etc. These

 may be useful in their own right but their primary purpose is to test and demonstrate the toolkit. User-facing programs
 should be their own projects that will provide proper attention to detail for their use cases.
 
 may be useful in their own right but their primary purpose is to test and demonstrate the toolkit. User-facing programs
 should be their own projects that will provide proper attention to detail for their use cases.
 


@@ -53,6 +51,6 @@ should be their own projects that will provide proper attention to detail for th
  LICENCE
 =========
 
  LICENCE
 =========
 

-Copyright 2024 Thomas Karpiniec <tom.karpiniec@outlook.com>
+Copyright 2025 Thomas Karpiniec <tom.karpiniec@outlook.com>

 
 M17 Rust Toolkit is made available under the MIT Licence. See LICENCE.TXT for details.
 
 M17 Rust Toolkit is made available under the MIT Licence. See LICENCE.TXT for details.