Skip to content

Add instructions on how to build to the README. #187

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add instructions on how to build to the README. #187

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37d273a
Add instructions on how to build to the README.
camilasan Sep 19, 2024
d43033e
Fix typos and improve instructions.
camilasan Feb 24, 2025
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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,22 @@ Just like all linuxdeploy plugins, the Qt plugin's behavior can be configured so
QML related:
- `$QML_SOURCES_PATHS`: directory containing the application's QML files — useful/needed if QML files are "baked" into the binaries. `$QT_INSTALL_QML` is prepended to this list internally.
- `$QML_MODULES_PATHS`: extra directories containing imported QML files (normally doesn't need to be specified).

## How to build it
1. Install the following dependencies:
- [patchelf](https://github.com/NixOS/patchelf)
- [cimg](https://cimg.eu/)
- optional - disable it with `USE_CCACHE=OFF` cmake var: [ccache](https://ccache.dev/)
2. [Fork this repository and clone it](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why would you suggest to fork the repository just to build it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why would you suggest to fork the repository just to build it?

If you want to contribute to the project, that is how you do it.
Only people with access to the repo don't need to fork.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean that was my point with this line, I could also remove it.

3. Initiate the git submodules.
```
cd <forked linux-deploy-qt>
git submodule update --init --recursive
```
4. Create the build folder and build it.
```
mkdir <build folder>
cd <build folder
cmake ../<forked linux-deploy-qt> -DUSE_CCACHE=OFF -DCMAKE_BUILD_TYPE=RelWithDebInfo -DBUILD_TESTING=ON -DSTATIC_BUILD=ON
make
```