Skip to content

Add build instructions to README.md#312

Open
surfdado wants to merge 1 commit into
vedderb:masterfrom
surfdado:readme
Open

Add build instructions to README.md#312
surfdado wants to merge 1 commit into
vedderb:masterfrom
surfdado:readme

Conversation

@surfdado

Copy link
Copy Markdown
Contributor

Added instructions that worked for me

Signed-off-by: Dado Mista <dadomista@gmail.com>
@kubark42

kubark42 commented Apr 25, 2023

Copy link
Copy Markdown
Contributor

This is (should be) natively supported already, although you have to have the bldc project installed first:

Windows: https://discord.com/channels/904830990319485030/910181652192448532/917434237991399424
POSIX-style: https://discord.com/channels/904830990319485030/910181652192448532/919240778088329267

@kubark42

Copy link
Copy Markdown
Contributor

From Discord links:

macOS/Linux

  1. Start with building the firmware as per the bldc repo's Readme.md
  2. Then make qt_install
  3. mkdir vesc_tool.build
  4. cd vesc_tool.build
    5a) For macOS: ../tools/Qt/5.15.2/clang_64/bin/qmake ../../vesc_tool/vesc_tool.pro
    5b) For Linux: ../tools/Qt/5.15.2/gcc_64/bin/qmake ../../vesc_tool/vesc_tool.pro
  5. make -j8
    7a) For macOS: ../tools/Qt/5.15.2/clang_64/bin/macdeployqt VESC\ Tool.app -dmg -qmldir=../../vesc_tool <-- This will make the VESC-tool and place it in vesc_tool.build/VESC Tool.dmg
    7b) For Linux: ../downloads/linuxdeployqt-continuous-x86_64.AppImage --appimage-extract-and-run ./vesc_tool_4.00 -qmldir=../../vesc_tool/ -appimage -always-overwrite -qmake=../tools/Qt/5.15.2/gcc_64/bin/qmake -unsupported-allow-new-glibc <-- This will make the VESC-tool and place it in either vesc_tool.build/Application-x86_64.AppImage or vesc_tool.build/vesc_tool_4.00

Windows

  1. Start with building the firmware as per the repo's Readme.md
  2. Then open up a cmd terminal (Resist the urge to run Powershell, that will break things.)
  3. make qt_install
  4. mkdir vesc_tool.build
  5. cd vesc_tool.build
  6. ..\tools\Qt\5.15.2\msvc2019_64\bin\qmake ..\..\vesc_tool\vesc_tool.pro
  7. make -j8
  8. ..\tools\Qt\5.15.2\msvc2019_64\bin\windeployqt --qmldir=..\..\vesc_tool\ .\release <-- This will make the VESC-tool and place it in the vesc_tool.build directory

@surfdado

Copy link
Copy Markdown
Contributor Author

I don't have linuxdeployqt-continuous-x86_64.AppImage in ../downloads

@kubark42

Copy link
Copy Markdown
Contributor

I don't have linuxdeployqt-continuous-x86_64.AppImage in ../downloads

Thanks! I'll try to fix that. linuxdeployqt is an oddball project, but really useful.

@surfdado

Copy link
Copy Markdown
Contributor Author

I've only ever needed linuxdeployqt when generating Qt installers - but considering how the instructions hard-code an obsolete version number (4.0) maybe we should just have a shell script (build_vesc_tool_.sh) that does all the steps you outlined above so users don't need to copy paste all that

@Ahelsamahy

Copy link
Copy Markdown

I was trying to make the same installation on M1 (macOS 14.6.1) but couldn't make it work. However, I managed to make it run after a clean installation using these steps here Compile Vesc Tool on MackBook

@albfan

albfan commented Feb 1, 2025

Copy link
Copy Markdown

In general expect that a project describe how you can get its dependecies, and even more per OS, is out of scope.

Just the claim "You need to use qtcreator first" is misleading and hacky

I suggest to close this. This might make sense on a wiki, or an article in forums

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants