Skip to content

Commit cf54565

Browse files
authored
Enhance building instructions for Windows and macOS
Updated Windows build instructions and added macOS installation step.
1 parent 8611a02 commit cf54565

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

docs/development/building-from-source.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Requirements
2424

2525
```sh
2626
sudo apt update
27-
sudo apt install python3-pip git
27+
sudo apt install -y --no-install-recommends python3-pip git gcc-multilib libc6-dev-i386
2828
pip3 install platformio
2929
export PATH=$PATH:~/.local/bin
3030
source ~/.bashrc
@@ -58,19 +58,30 @@ pio run -e m5stack-cplus1_1 -t build-firmware
5858

5959
### Windows
6060

61+
# Windows build
6162
* Install [Git](https://git-scm.com/download/win)
6263
* Install Python using the Microsoft Store
6364
* Install VSCode
64-
* Download or Git clone the repository
65-
* Within VSCode, `File -> Open Folder...` and select the folder you just extracted/cloned
66-
* If it doesn't prompt to install PlatformIO, click on "Extentions" (4 swares icon on the left) and install PlatformIO (and restart VSCode)
65+
* Install MSYS2 https://www.msys2.org/ at default path
66+
* Open C:\msys64\ucrt64.exe
67+
* Run on UCRT64 terminal: `pacman -S --needed mingw-w64-i686-toolchain`
68+
* Add C:\msys64\mingw32\bin to PATH, cmd: `setx PATH "%PATH%;C:\msys64\mingw32\bin"`
69+
* Download the repository and extract it somewhere you want
70+
* Within VSCode, `File>Open Folder...` and select the folder of the firmware
71+
* If it doesn't prompt to install Platformio, click on "Extentions" (4 swares icon on the left) and install Platformio (and restart VsCode)
6772
* In the Status bar (down on the screen) click where is written `Default (Bruce-main)`
68-
* A menu will appear in the Search bar (up on screen), select your device "env"
73+
* A little Menu will appear in the Search bar (up on screen), select your device "env"
6974
* Now click in the :heavy_check_mark: Icon in the Status Bar (beside the cute little House), it will start building your project
70-
* If you want to upload directly, you can do it clicking in the "->" arrow to upload to your device
75+
* if you want to upload directly, you can do it clicking in the "->" arrow to upload to your device
7176
* If you want to output a binary you can flash, use the "build-firmware" Custom task in the PlatformIO Extension Sidebar Menu named "project tasks"
7277

7378

79+
### On MAC
80+
* run on terminal: `xcode-select --install`
81+
82+
7483
## GitHub Actions
7584

7685
You can use the Github workflow to build the binaries for you with Actions, the last releases are available in the Artifacts, but you can fork the project and make the changes you want to this, then build on your using your own Actions.
86+
87+

0 commit comments

Comments
 (0)