From 739e5861c2e47db251725163fcd91cd822cf97b7 Mon Sep 17 00:00:00 2001 From: Ulf Lilleengen Date: Sat, 18 May 2024 10:17:03 +0200 Subject: convert from antora to asciidoctor --- docs/README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'docs/README.md') diff --git a/docs/README.md b/docs/README.md index 0bf3a6c89..8b9a3c48d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,9 @@ # embassy docs -The documentation hosted at [https://embassy.dev/book](https://embassy.dev/book). Building the documentation requires -cloning the [embassy-book](https://github.com/embassy-rs/embassy-book) repository and following the instructions. +The documentation hosted at [https://embassy.dev/book](https://embassy.dev/book). Building the documentation requires the [asciidoctor](https://asciidoctor.org/) tool, and can be built like this: + +``` +asciidoctor -d book -D thebook/ index.adoc +``` + +Then open the generated file `thebook/index.html`. -- cgit