diff --git a/README.md b/README.md index 9dfc92e9..cb86ac00 100755 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ # muX muOS Frontend + + +## How to compile +This [PR](https://github.com/MustardOS/frontend/pull/2) explains how to setup a local development environment. +However an alternative is to use a docker image to do the build + +``` +docker run --platform linux/amd64 -v .:/workspace --rm -it shengy/muos-development:latest /bin/bash +``` + +Note that `DEVICE` is preset to `RG35XXPLUS`, change it as needed. + +See [muos-docker](https://github.com/ysheng26/muos-docker) for the `Dockerfile`.