From 4c44611f2053a25968a227ad1dff8f03baa1d1e3 Mon Sep 17 00:00:00 2001 From: Grazfather Date: Sun, 18 Feb 2024 03:38:29 -0500 Subject: [PATCH] Fix requirements.txt and update README (#172) --- README.md | 12 +++++++++--- tools/requirements.txt | 2 +- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 446f205..fab78f1 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,13 @@ Right now, the developer experience is not optimal due to 0.11 not really suppor If you want to test your changes, you gotta to the following: -**Step 1:** Create a deployment for local usage: +**Step 1:** Install required python pacakges: + +```sh-session +[user@host] microzig-monorepo/ $ pip3 install -r tools/requirements.txt +``` + +**Step 2:** Create a deployment for local usage: ```sh-session [user@host] microzig-monorepo/ $ python3 ./tools/bundle.py --debug @@ -65,7 +71,7 @@ bundling microchip/avr... This command yields output in `./microzig-deploy` that is meant to be fetched via `http://localhost:8080/`. -**Step 2:** To serve the files on this port, you can start a pre-bundled web server: +**Step 3:** To serve the files on this port, you can start a pre-bundled web server: ```sh-session [user@host] microzig-monorepo/ $ python3 ./tools/demo-server.py @@ -77,7 +83,7 @@ start fetching packages from this. Now you can use curl to fetch the packages, or you can just create a local development project. -**Step 3:** You can use the tool `tools/patch-build-zon.py` to patch/upgrade your development project inplace: +**Step 4:** You can use the tool `tools/patch-build-zon.py` to patch/upgrade your development project inplace: ```sh-session [user@host] microzig-monorepo/ $ python3 ./tools/patch-build-zon.py /tmp/dev-project/build.zig.zon diff --git a/tools/requirements.txt b/tools/requirements.txt index b43b94f..d0f9080 100644 --- a/tools/requirements.txt +++ b/tools/requirements.txt @@ -2,4 +2,4 @@ dataclasses_json==0.6.3 marshmallow typing-inspect semver -pathspec +pathspec>=0.12.0