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.

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

Add build instructions to README.md #312

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,15 @@ If you have custom hardware and you want to add support for it in the official r
1) Go to https://github.com/vedderb/bldc and use the github fork function.
2) Make your changes, test them and make a pull request to the main repository.
3) If the pull request gets accepted your hardware will become part of the next official release. It will show up in the binary beta typically after a few days and in the stable version the next time a stable release is made.

## How to build

Download and install Qt 5.15 open source, make sure to check the 5.15.x option in the installer.

Before you can build from the command line you need to build it at least once from the UI. Open qtcreator, open the project vesc_tool.pro, and configure it (all defaults), then build/run.

Now add qmake to your path and you should be able to run the build_lin scripts.

It will complain about res_fw.qrc missing. To get around that, you can un-comment the "exclude_fw" line in vesc_tool.pro - but then you will not have the built-in firmware files included in your tool.

Hopefully someone can add how to also include the firmware files...