Add `requirements.txt` and update instructions (#40)
This commit is contained in:
parent
0e5e250ade
commit
fd0122053c
18
README.md
18
README.md
|
@ -15,7 +15,7 @@ NodeMCU PyFlasher doesn't have to be installed, just double-click it and it'll s
|
|||
## Status
|
||||
Scan the [list of open issues](https://github.com/marcelstoer/nodemcu-pyflasher/issues) for bugs and pending features.
|
||||
|
||||
**Note**
|
||||
**Note**
|
||||
|
||||
This is my first Python project. If you have constructive feedback as for how to improve the code please do reach out to me.
|
||||
|
||||
|
@ -30,9 +30,19 @@ All open-source development by the author is donationware. Show your love and su
|
|||
## Build it yourself
|
||||
If you want to build this application yourself you need to:
|
||||
|
||||
- Install Python 3.x
|
||||
- Install [wxPython 4.x](https://wxpython.org/) manually or run `pip install wxpython`
|
||||
- Install [esptool.py](https://github.com/espressif/esptool#easy-installation) and its dependencies manually or run `pip install esptool`
|
||||
- Install [Python 3.x](https://www.python.org/downloads/) and [Pip](https://pip.pypa.io/en/stable/installing/) (it comes with Python if installed from `python.org`).
|
||||
- Create a virtual environment with `python -m venv venv`
|
||||
- Activate the virtual environment with `. venv/bin/activate` (`. venv/Scripts/activate` if you are on Windows with [Cygwin](https://www.cygwin.com/) or [Mingw](http://mingw.org/))
|
||||
- Run `pip install -r requirements.txt`
|
||||
|
||||
**A note on Linux:** As described on the [downloads section of `wxPython`](https://www.wxpython.org/pages/downloads/), wheels for Linux are complicated and may require you to run something like this to install `wxPython` correctly:
|
||||
|
||||
```bash
|
||||
# Assuming you are running it on Ubuntu 18.04 LTS with GTK3
|
||||
pip install -U \
|
||||
-f https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-18.04 \
|
||||
wxPython
|
||||
```
|
||||
|
||||
## Why this project exists
|
||||
|
||||
|
|
|
@ -0,0 +1,3 @@
|
|||
esptool==2.5.1
|
||||
wxPython==4.0.3
|
||||
PyInstaller==3.4
|
Loading…
Reference in New Issue