Skip to content

Commit 0a1e28a

Browse files
committed
README: Update for Pycopy project.
1 parent 910ef95 commit 0a1e28a

File tree

1 file changed

+15
-17
lines changed

1 file changed

+15
-17
lines changed

README.rst

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,17 @@ written by Charles Leifer as a demo of how to write a simple, but slick
66
web application using the Flask web micro-framework. The application is
77
described in the blog post
88
http://charlesleifer.com/blog/saturday-morning-hack-a-little-note-taking-app-with-flask/
9-
. Notes Pico is a port of this application to Picoweb web pico-framework
10-
for MicroPython. It was ported by Paul Sokolovsky.
9+
. Notes Pico is a port of this application to the
10+
[Picoweb](https://github.com/pfalcon/picoweb/) web pico-framework
11+
for Pycopy (https://github.com/pfalcon/pycopy), a minimalist Python
12+
implementation. It was ported by Paul Sokolovsky.
1113

12-
**NOTE**: Recent versions of ``uasyncio`` async framework and Picoweb
13-
web framework, and thus Notes Pico, require "advanced" fork of
14-
MicroPython at https://github.com/pfalcon/micropython .
1514

15+
Deploying on Pycopy "Unix" version
16+
----------------------------------
1617

17-
Deploying on MicroPython "Unix" version
18-
---------------------------------------
19-
20-
To install and run the application, you should install MicroPython
21-
"Unix" port as described at https://github.com/pfalcon/micropython .
18+
To install and run the application, you should install Pycopy
19+
"Unix" port as described at https://github.com/pfalcon/pycopy .
2220
Once you have ``micropython`` executable in your PATH (recommended, but
2321
not strictly necessary), change directory to where you want to install
2422
the app (``~/tmp/`` should be good for a quick test) and install
@@ -41,26 +39,26 @@ simple and low-resource, so supports only plain-text notes, unlike the
4139
original Flask application.
4240

4341

44-
Deploying on embedded MicroPython targets
45-
-----------------------------------------
42+
Deploying on embedded Pycopy targets
43+
------------------------------------
4644

47-
Notes Pico can also run on "embedded" (microcontroller) MicroPython
45+
Notes Pico can also run on "embedded" (microcontroller) Pycopy
4846
targets with networking capabilities and suitable heap size (TBC).
4947
As Notes Pico is full-stack application and contains relatively a
5048
lot of code, the only realistic way to deploy it on such systems is
5149
using "frozen bytecode" approach, where pre-compiled Python modules
5250
are made part of the binary firmware image to flash on the target.
53-
Instructions below use MicroPython ESP8266 port as an example.
51+
Instructions below use Pycopy ESP8266 port as an example.
5452

55-
1. ``cd micropython/esp8266``
53+
1. ``cd pycopy/ports/esp8266``
5654
2. ``micropython -m upip install -p modules notes-pico``
5755
3. ``make``
5856
4. ``make deploy`` (see README in the directory for more params)
5957
5. Boot ESP8266 module, run following commands at the device prompt.
6058
6. ``import notes_pico.__main__``
6159
7. ``notes_pico.__main__.main(host="0.0.0.0")``
6260
8. Connect with a web browser to http://`DEVICE_IP`:8081, where
63-
`DEVICE_IP` is an IP address of ESP8266 device. (Consult MicroPython
61+
`DEVICE_IP` is an IP address of ESP8266 device. (Consult Pycopy
6462
ESP8266 port documentation for network connection setup.)
6563

6664

@@ -73,7 +71,7 @@ Notes Pico supports 3 storage backends:
7371
* Filesystem
7472
* SQLite3
7573

76-
As a first step towards portability to MicroPython microcontroller
74+
As a first step towards portability to Pycopy microcontroller
7775
versions, the default backend for the package installed from PyPI
7876
via the commands in the previous section is BTree database. The
7977
notes are stored in ``notes.db`` database file of the current

0 commit comments

Comments
 (0)