Minor doc changes.

peterhinch · peterhinch · commit ab6cbb6e41aa · 2023-02-17T15:32:25.000Z
diff --git a/v3/README.md b/v3/README.md
@@ -19,8 +19,8 @@ and incremental encoders.
 is a guide to interfacing interrupts to `uasyncio`.
 
 [Event-based programming](./docs/EVENTS.md) is a guide to a way of writing
-applications and device drivers which largely does away with callbacks. Assumes
-some knowledge of `uasyncio`.
+applications and device drivers which largely does away with callbacks. The doc
+assumes some knowledge of `uasyncio`.
 
 [Threading](./docs/THREADING.md) is a guide to the use of multi-threaded and
 multi-core programming. Code is offered to enable a `uasyncio` application to
@@ -51,26 +51,38 @@ Documented in the [tutorial](./docs/TUTORIAL.md).
 Documented in the [tutorial](./docs/TUTORIAL.md). Comprises:
  * Implementations of unsupported CPython primitives including `barrier`,
  `queue` and others.
- * An additional primitive `Message`.
  * A software retriggerable monostable timer class `Delay_ms`, similar to a
  watchdog.
  * Two primitives enabling waiting on groups of `Event` instances.
 
-### 1.3.3 Asynchronous device drivers
+### 1.3.3 Threadsafe primitives
+
+[This doc](https://github.com/peterhinch/micropython-async/blob/master/v3/docs/THREADING.md)
+describes issues linking `uasyncio` code with code running on other cores or in
+other threads. The `threadsafe` directory provides:
+
+ * A threadsafe primitive `Message`.
+ * `ThreadSafeQueue`
+ * `ThreadSafeEvent` Extends `ThreadsafeFlag`.
+
+The doc also provides code to enable `uasyncio` to handle blocking functions
+using threading.
+
+### 1.3.4 Asynchronous device drivers
 
 These are documented
 [here](https://github.com/peterhinch/micropython-async/blob/master/v3/docs/DRIVERS.md):
  * Classes for interfacing switches, pushbuttons and ESP32 touch buttons.
  * Drivers for ADC's
  * Drivers for incremental encoders.
 
-### 1.3.4 A scheduler
+### 1.3.5 A scheduler
 
 This [lightweight scheduler](./docs/SCHEDULE.md) enables tasks to be scheduled
 at future times. These can be assigned in a flexible way: a task might run at
 4.10am on Monday and Friday if there's no "r" in the month.
 
-### 1.3.5 Asynchronous interfaces  
+### 1.3.6 Asynchronous interfaces  
 
 These device drivers are intended as examples of asynchronous code which are
 useful in their own right:
diff --git a/v3/docs/TUTORIAL.md b/v3/docs/TUTORIAL.md
@@ -11,7 +11,7 @@ including device drivers, debugging aids, and documentation.
 # Contents
 
  0. [Introduction](./TUTORIAL.md#0-introduction)  
-  0.1 [Installing uasyncio](./TUTORIAL.md#01-installing-uasyncio)  
+  0.1 [Installing uasyncio](./TUTORIAL.md#01-installing-uasyncio) Also the optional extensions.  
  1. [Cooperative scheduling](./TUTORIAL.md#1-cooperative-scheduling)  
   1.1 [Modules](./TUTORIAL.md#11-modules)  
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1.1.1 [Primitives](./TUTORIAL.md#111-primitives)  
@@ -118,14 +118,12 @@ CPython V3.8 and above.
 
 ## 0.1 Installing uasyncio
 
-Firmware builds after V1.13 incorporate `uasyncio`. The version may be checked
-by issuing at the REPL:
-```python
-import uasyncio
-print(uasyncio.__version__)
-```
-Version 3 will print a version number. Older versions will throw an exception:
-installing updated firmware is highly recommended.
+Firmware builds after V1.13 incorporate `uasyncio`. Check the firmware version
+number reported on boot and upgrade if necessary.
+
+This repository has optional unofficial primitives and extensions. To install
+these the repo should be cloned to a PC. The directories `primitives` and
+`threadsafe` (with contents) should be copied to the hardware plaform.
 
 ###### [Main README](../README.md)
 
