Skip to content

Commit 0680495

Browse files
committed
update documentation ahead of v1
Add detail on what is not supported. Change from "alpha" to "beta" for expressing the relative quality level of this software.
1 parent 93f34ee commit 0680495

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

Diff for: README.rst

+4-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ development machine using the binutils-esp32ulp toolchain from Espressif.
1515
Status
1616
------
1717

18-
The most commonly used simple stuff should work.
18+
The most commonly used stuff should work. Many ULP code examples found on
19+
the web will work unmodified. Notably, assembler macros and #include processing
20+
are not supported.
1921

2022
Expressions in assembly source code are supported and get evaluated during
2123
assembling. Only expressions evaluating to a single integer are supported.
@@ -34,7 +36,7 @@ tested with MicroPython v1.12 and v1.17. It has been tested on real ESP32's
3436
of the type ESP32D0WDQ6 (revision 1) without SPIRAM. It has also been tested
3537
on the Unix port.
3638

37-
There might be some stuff missing, some bugs and other symptoms of alpha
39+
There might be some stuff missing, some bugs and other symptoms of beta
3840
software. Also, error and exception handling is rather rough yet.
3941

4042
Please be patient or contribute missing parts or fixes.

0 commit comments

Comments
 (0)