Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix requirements.txt and update README #172

Merged
merged 1 commit into from
Feb 18, 2024
Merged

Fix requirements.txt and update README #172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
ikskuh marked this conversation as resolved.
Show resolved Hide resolved

**Step 2:** Create a deployment for local usage:

```sh-session
[user@host] microzig-monorepo/ $ python3 ./tools/bundle.py --debug
Expand All @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion tools/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ dataclasses_json==0.6.3
marshmallow
typing-inspect
semver
pathspec
pathspec>=0.12.0