Skip to content

Commit b6ec476

Browse files
committed
Update README.md
1 parent b41a7c2 commit b6ec476

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@
1111
<a href="https://github.com/TOPLLab/WARDuino/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-MPL_2.0-blue.svg"></a>
1212
</p>
1313

14-
<h4>
14+
<b>
1515
<a href="./README.md#build-and-development-instructions">Installation</a>
1616
<span> | </span>
1717
<a href="./examples/">Examples</a>
1818
<span> | </span>
1919
<a href="./README.md#webassembly-specification-tests">Run Specification tests</a>
2020
<span> | </span>
2121
<a href="https://topllab.github.io/WARDuino/guide/get-started.html">Documentation</a>
22-
</h4>
22+
</b>
2323

2424
</div>
2525

@@ -32,11 +32,13 @@ This project is released under the Mozilla Public License 2.0, and is being deve
3232
+ The virtual machine allows developers to implement their own primitives in C++, which are callable from Wasm.
3333
+ The WARDuino project also includes a [VS Code extension](https://github.com/TOPLLab/WARDuino-VSCode) to use both the remote debugging and the out-of-place debugging facilities offered by the virtual machine.
3434

35-
*Note: WARDuino is not 1.0, since this is an active research project. Expect possible bugs or performance issues.*
35+
> [!WARNING]
36+
> WARDuino is not 1.0, since this is an active research project. Expect possible bugs or performance issues.
3637
3738
## Build and Development Instructions
3839

39-
Supported platforms: Linux (Ubuntu), macOS, ESP-IDF, Arduino
40+
> [!NOTE]
41+
> **Supported platforms:** Linux (Ubuntu), macOS, ESP-IDF, Arduino
4042
4143
The project uses CMake. Quick install looks like this:
4244

@@ -55,7 +57,8 @@ The WARDuino VM can be compiled with both the Arduino and ESP-IDF toolchains, an
5557

5658
### Build for ESP-IDF
5759

58-
> warning: primitive support for IDF is under construction
60+
> [!WARNING]
61+
> Primitive support for IDF is under construction.
5962
6063
Before you can compile and flash with ESP-IDF, you must install and enable [the toolchain](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-macos-setup.html).
6164
You also need to disable the watchdog timer:
@@ -147,9 +150,9 @@ npm run spectest
147150

148151
For a feature request or bug report, create a [GitHub issue](https://github.com/TOPLLab/WARDuino/issues).
149152

150-
## LICENCE
153+
## Acknowledgments
151154

152-
WARDuino by Robbert Gurdeep Singh, Tom Lauwaerts, Christophe Scholliers and Joel Martin is licensed under a [MPL-2.0 License](./LICENSE).
155+
WARDuino by Robbert Gurdeep Singh, Tom Lauwaerts, Carlos Rojas Castillo, and Christophe Scholliers is licensed under a [MPL-2.0 License](./LICENSE).
153156
This is a derivative work of [kanaka/wac](https://github.com/kanaka/wac) by Joel Martin.
154157

155158
If you need to cite WARDuino in your research, use:

0 commit comments

Comments
 (0)