Skip to content

Commit 0f1022e

Browse files
committed
added readme
1 parent 6ffc658 commit 0f1022e

1 file changed

Lines changed: 6 additions & 17 deletions

File tree

README.adoc

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,16 @@
11
:fn-ninjas: footnote:[https://ninjas.cl]
2+
:fn-elixircl: footnote:[https://elixircl.github.io]
23

3-
= Antora Docs Bootstrap
4+
= 🧙 Elixir Robotics 🤖
45

5-
This is a simple configuration for creating documentation with https://docs.antora.org/[Antora Docs].
6+
A book about projects using _AtomVM_ with _ESP32_.
7+
And some additional info about electronics, circuits and robotics.
68

7-
It includes:
8-
9-
- Dockerfile (podman)
10-
- Kroki (Plant UML and others)
11-
- Search
12-
13-
== Commands
14-
15-
- `make build`: Compiles Antora Docs.
16-
- `make install`: Builds the Dockerfile.
17-
- `make server`: Starts a new server for the html version. (requires python3).
9+
image::https://elixircl.github.io/elixir-robotics/controllers/_images/esp32/gladiator/gladiador.jpg[ESP32 Gladiator]
1810

1911
== License
2012

21-
Created with ❤️ by https://ninjas.cl[Camilo Castro] and https://github.com/NinjasCL/antora-docs-bootstrap/graphs/contributors[contributors]footnote:[https://github.com/NinjasCL/antora-docs-bootstrap/graphs/contributors]. for https://ninjas.cl[Ninjas.cl]{fn-ninjas}.
13+
Created with ❤️ by https://ninjas.cl[Camilo Castro] and https://github.com/ElixirCL/elixir-robotics/graphs/contributors[contributors]footnote:[https://github.com/ElixirCL/elixir-robotics/graphs/contributors]. for https://elixircl.github.io[Elixir Chile]{fn-elixircl}.
2214

2315
This document is licensed with http://creativecommons.org/licenses/by-nc-sa/4.0/[Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International]footnote:[http://creativecommons.org/licenses/by-nc-sa/4.0/]
2416

@@ -36,6 +28,3 @@ Source code licensed with https://opensource.org/licenses/BSD-2-Clause[BSD-2]foo
3628
</a>.
3729
</p>
3830
++++
39-
40-
41-
See Also: https://github.com/NinjasCL/asciidoc-book-template/tree/main[Asciidoc Book Template]

0 commit comments

Comments
 (0)