djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[readme] minor clarification / deduplication

Browse Source
This commit is contained in:
Artyom Skrobov 2021-03-07 09:19:49 +02:00 committed by GitHub
parent 08e1f926fe
commit 1d33353ed3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.rst
View File

@ -113,10 +113,9 @@ Behavior
- ``code.py`` (or ``main.py``) is run after every reload until it - ``code.py`` (or ``main.py``) is run after every reload until it
finishes or is interrupted. After it is done running, the vm and finishes or is interrupted. After it is done running, the vm and
hardware is reinitialized. **This means you cannot read state from** hardware is reinitialized. **This means you cannot read state from**
``code.py`` **in the REPL anymore.** CircuitPython's goal for this ``code.py`` **in the REPL anymore, as the REPL is a fresh vm.** CircuitPython's goal for this
change includes reducing confusion about pins and memory being used. change includes reducing confusion about pins and memory being used.
- After ``code.py`` the REPL can be entered by pressing any key. It no - After the main code is finished the REPL can be entered by pressing any key.
longer shares state with ``code.py`` so it is a fresh vm.
- Autoreload state will be maintained across reload. - Autoreload state will be maintained across reload.
- Adds a safe mode that does not run user code after a hard crash or - Adds a safe mode that does not run user code after a hard crash or
brown out. The hope is that this will make it easier to fix code that brown out. The hope is that this will make it easier to fix code that
@ -126,8 +125,7 @@ Behavior
- RGB status LED indicating CircuitPython state, and errors through a sequence of colored flashes. - RGB status LED indicating CircuitPython state, and errors through a sequence of colored flashes.
- Re-runs ``code.py`` or other main file after file system writes over USB mass storage. (Disable with - Re-runs ``code.py`` or other main file after file system writes over USB mass storage. (Disable with
``supervisor.disable_autoreload()``) ``supervisor.disable_autoreload()``)
- Entering the REPL after the main code is finished requires a key press which enters the REPL and - Autoreload is disabled while the REPL is active.
disables autoreload.
- Main is one of these: ``code.txt``, ``code.py``, ``main.py``, - Main is one of these: ``code.txt``, ``code.py``, ``main.py``,
``main.txt`` ``main.txt``
- Boot is one of these: ``settings.txt``, ``settings.py``, ``boot.py``, - Boot is one of these: ``settings.txt``, ``settings.py``, ``boot.py``,