nordic-dev.net/embassy
2
0
Fork 0
mirror of https://github.com/embassy-rs/embassy.git synced 2024-11-21 22:32:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

move images and add makefile

Browse Source
This commit is contained in:
Ulf Lilleengen 2024-05-18 10:22:33 +02:00
parent 739e5861c2
commit 2991099daa
9 changed files with 11 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/Makefile Normal file
View File

@ -0,0 +1,8 @@
all:
asciidoctor -d book -D thebook/ index.adoc
cp -r images thebook
clean:
rm -rf thebook
.PHONY: all clean

4
docs/README.md
View File

@ -1,9 +1,9 @@
# embassy docs # embassy docs
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: The documentation hosted at [https://embassy.dev/book](https://embassy.dev/book). Building the documentation requires the [asciidoctor](https://asciidoctor.org/) tool, and can built running `make` in this folder:
``` ```
asciidoctor -d book -D thebook/ index.adoc make
``` ```
Then open the generated file `thebook/index.html`. Then open the generated file `thebook/index.html`.

0
docs/modules/ROOT/images/bootloader_flash.png → docs/images/bootloader_flash.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 31 KiB

0
docs/modules/ROOT/images/embassy_executor.drawio → docs/images/embassy_executor.drawio
View File

0
docs/modules/ROOT/images/embassy_executor.png → docs/images/embassy_executor.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 118 KiB

After

Width:  |  Height:  |  Size: 118 KiB

0
docs/modules/ROOT/images/embassy_irq.drawio → docs/images/embassy_irq.drawio
View File

0
docs/modules/ROOT/images/embassy_irq.png → docs/images/embassy_irq.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 131 KiB

After

Width:  |  Height:  |  Size: 131 KiB

1
docs/index.adoc
View File

@ -4,6 +4,7 @@
:toc: :toc:
:toc-placement: left :toc-placement: left
:toclevels: 2 :toclevels: 2
:imagesdir: images
# Embassy Book # Embassy Book

19
docs/modules/ROOT/nav.adoc
View File

@ -1,19 +0,0 @@
* xref:getting_started.adoc[Getting started]
** xref:basic_application.adoc[Basic application]
** xref:project_structure.adoc[Project Structure]
** xref:new_project.adoc[Starting a new Embassy project]
** xref:best_practices.adoc[Best Practices]
* xref:runtime.adoc[Executor]
* xref::time_keeping.adoc[Time-keeping]
* xref:sharing_peripherals.adoc[Sharing peripherals]
* xref:hal.adoc[HAL]
** xref:layer_by_layer.adoc[Anatomy of an async HAL]
** xref:nrf.adoc[nRF]
** xref:stm32.adoc[STM32]
* xref:bootloader.adoc[Bootloader]
* xref:examples.adoc[Examples]
* xref:developer.adoc[Developer Docs]
** xref:developer_stm32.adoc[Developer Docs: STM32]
* xref:embassy_in_the_wild.adoc[Embassy in the wild]
* xref:faq.adoc[Frequently Asked Questions]