diff --git a/README.md b/README.md index c5dee12..3221447 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,24 @@ It is now production-ready (tested on 2x16 displays only at the moment.) ToDo: M - [x] make the project a valid python package +# How to get it + +To "install" the library on your Pico, clone the repository first using `git clone`. Open [Thonny](https://thonny.org). There, open a file from "This computer" (thonny asks for the location after clicking on "Open"), and select the `__init__.py` from this repository. To get this file to your Pico's storage, choose "Save as" and choose "Raspberry Pi Pico" as the location. + +Now, create a new directory called lcdMenu in the root of the Pico's file system (you can do that in the "magic" /lib folder too, makes no difference), and after that save the file there (with `__init__.py` being the file name). + +Now you can use the library using `import lcdMenu` in any of your scripts! + + +# Usage + +For basic usage, you just have to create an LCD object, use it to create a lcdMenu along with some other arguments. On this newly created object, run the `setup()` method with your menu item list. Then, start the menu by calling the (blocking) `run()` method on it. + +To stop a running instance of lcdMenu (started by `run()`), call the method `stop()` on it! + +For further usage, see the comments above the respective method definition in question in the [__init__.py](__init__.py) file. These try to describe the behaviour of each parameter pretty precise. Also, have a look into the examples which can be found in the [examples](examples/) folder. + + ## Gallery Here are some of examples of how a lcdMenu will look, showcasing the amount of options you have with lcdMenu. Currently, as the library is only tested with 2x16 displays, these are the only ones showing up below - but on 4x20, it should look the same except it's bigger! @@ -101,3 +119,4 @@ Here are some of examples of how a lcdMenu will look, showcasing the amount of o ## License This project is licensed under the GPL-v3-or-later. A copy can be found [here](LICENSE). + diff --git a/example_quittable.py b/examples/quittable.py similarity index 100% rename from example_quittable.py rename to examples/quittable.py diff --git a/example_simple.py b/examples/simple.py similarity index 100% rename from example_simple.py rename to examples/simple.py diff --git a/example_submenu.py b/examples/submenu.py similarity index 100% rename from example_submenu.py rename to examples/submenu.py