From 3dcf582a141088866e3d24953c1ea5d4c47248fe Mon Sep 17 00:00:00 2001 From: Eliza Weisman Date: Mon, 4 Sep 2023 14:12:04 -0700 Subject: [PATCH] docs(maitake-sync): link to announcement in readme --- maitake-sync/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/maitake-sync/README.md b/maitake-sync/README.md index 47bdf26a..f552793f 100644 --- a/maitake-sync/README.md +++ b/maitake-sync/README.md @@ -33,6 +33,9 @@ supporting `#![no_std]` projects. It was initially developed as part of [mycelium] and [mnemOS] operating systems, but it may be useful for other projects as well. +To learn a bit of the backstory behind `maitake-sync`, see the [announcement +post](https://www.elizas.website/announcing-maitake-sync.html)! + > **Note** > > This is a hobby project. I'm working on it in my spare time, for my own @@ -75,7 +78,7 @@ The following synchronization primitives are provided: In addition, the [`util` module] contains a collection of general-purpose utilities for implementing synchronization primitives, and the [`spin` module] contains implementations of *non-async*, spinning-based synchronization -primitives. +primitives. [`core::task`]: https://doc.rust-lang.org/stable/core/task/index.html [`core::future`]: https://doc.rust-lang.org/stable/core/future/index.html