Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 2.27 KB

SW-BUILD.md

File metadata and controls

58 lines (38 loc) · 2.27 KB
Raw

PIXELIX

PIXELIX

License

Build The Software

Retrieve The Project

Open a console (windows: git bash) and get the project via

$ git clone https://github.com/BlueAndi/Pixelix

Example:

GitCloneOnConsole

⚠️ If you download the project from github, because you skipped the git installation, the build may fail because it can happen that other necessary libraries can not be automatically cloned by PlatformIO.

Build Project

Now its time to build the software for the appropriate target.

  1. Load workspace in VSCode.
  2. Change to PlatformIO toolbar (click on the head of the ant in the left column).

VSCodePIOIcon

  1. Lets now build the software independent of your specific board, just to see whether it works by Project Tasks -> Default -> Build All or via hotkey ctrl-alt-b

VSCodePIODefault

  1. If no error happened, you are ready.

VSCodePIODefaultBuild

Note, the default project is esp32 DevKit v1 board, programming via USB.

Next Step

The toolchain is working and the firmware gets built. Next step is now to build it specific for your target and upload it.

Issues, Ideas And Bugs

If you have further ideas or you found some bugs, great! Create a issue or if you are able and willing to fix it by yourself, clone the repository and create a pull request.

License

The whole source code is published under the MIT license. Consider the different licenses of the used third party libraries too!

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any additional terms or conditions.