Skip to content

Commit 0028196

Browse files
committed
remove duplication between README and Documentation
Also move badges to the top of README where they can be stripped away more easily when generating the project description for PyPI.
1 parent df882c8 commit 0028196

File tree

2 files changed

+22
-42
lines changed

2 files changed

+22
-42
lines changed

README.rst

+9-6
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1-
=====================
2-
py-esp32-ulp
3-
=====================
1+
.. start-badges
42
53
.. image:: ../../actions/workflows/run_tests.yaml/badge.svg
64
:height: 20px
75
:target: ../../actions/workflows/run_tests.yaml
86
:alt: Build Status
97

8+
.. end-badges
9+
10+
=====================
11+
py-esp32-ulp
12+
=====================
13+
1014
py-esp32-ulp is an assembler toolchain for the ESP32 ULP (Ultra Low-Power)
1115
Co-Processor, written in MicroPython.
1216

@@ -16,6 +20,8 @@ ULP machine code binary, directly on the ESP32 microcontroller.
1620
This is intended as an alternative approach to assembling such programs using
1721
the binutils-esp32ulp toolchain from Espressif on a development machine.
1822

23+
It can also be useful in cases where binutils-esp32ulp is not available.
24+
1925

2026
Features
2127
--------
@@ -49,9 +55,6 @@ To get going run the following directly on the ESP32:
4955
The `counter.py </examples/counter.py>`_ example shows how to assemble code, load
5056
and run the resulting binary and exchange data between the ULP and the main CPU.
5157

52-
You can also try the `blink.py </examples/blink.py>`_ example, which shows how to
53-
let the ULP blink an LED.
54-
5558

5659
Documentation
5760
-------------

docs/index.rst

+13-36
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,13 @@
11
py-esp32-ulp Documentation
22
==========================
33

4-
py-esp32-ulp is an assembler toolchain for the ESP32 ULP (Ultra Low-Power)
5-
Co-Processor, written in MicroPython.
6-
74
.. contents:: Table of Contents
85

96

10-
What is it useful for?
11-
----------------------
12-
13-
py-esp32-ulp can translate small assembly language programs to a
14-
loadable/executable ULP machine code binary, directly on the ESP32
15-
microcontroller.
16-
17-
This is intended as an alternative approach to assembling such programs using
18-
the binutils-esp32ulp toolchain from Espressif on a development machine.
19-
20-
It can also be useful in cases where binutils-esp32ulp is not available.
21-
22-
23-
Features
7+
Overview
248
--------
259

26-
The following features are supported:
27-
28-
* the entire `ESP32 ULP instruction set <https://esp-idf.readthedocs.io/en/latest/api-guides/ulp_instruction_set.html>`_
29-
* constants defined with ``.set``
30-
* constants defined with ``#define``
31-
* expressions in assembly code and constant definitions
32-
* RTC convenience macros (e.g. WRITE_RTC_REG)
33-
* many ESP32 ULP code examples found on the web will work unmodified
34-
35-
36-
Limitations
37-
-----------
38-
39-
Currently the following are not supported:
40-
41-
* assembler macros using ``.macro``
42-
* preprocessor macros using ``#define A(x,y) ...``
43-
* including files using ``#include``
44-
* ESP32-S2 (not binary compatible with the ESP32)
10+
`README.rst </README.rst>`_ gives a general overview of this project.
4511

4612

4713
Installation
@@ -170,6 +136,17 @@ found as part of Arduino/ESP-IDF projects.
170136
The preprocessor and how to use it is documented here: `Preprocessor support </docs/preprocess.rst>`_.
171137

172138

139+
Limitations
140+
-----------
141+
142+
Currently the following are not supported:
143+
144+
* assembler macros using ``.macro``
145+
* preprocessor macros using ``#define A(x,y) ...``
146+
* including files using ``#include``
147+
* ESP32-S2 (not binary compatible with the ESP32)
148+
149+
173150
Testing
174151
-------
175152

0 commit comments

Comments
 (0)