Skip to content

Commit

Permalink
rename the download script
Browse files Browse the repository at this point in the history
In the Python ecosystem, 'setup.py' is used for packaging projects. Rename
the download scripts to avoid conflicts and confusion with Python packaging
tools.
  • Loading branch information
christianrauch committed Oct 27, 2024
1 parent bfb0a9d commit 5732c35
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ jobs:
shell: bash
run: |
pip install pyyaml requests py7zr==0.21 tqdm_loggable
python setup.py --export_variables
python install-sdk.py --export_variables
cat env >> $GITHUB_ENV
- name: build plugin
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Note: Qt Creator from the online installer may notify you about available update

### Dependencies

To build the Qt Creator plugin, you will need Qt Creator, the matching "Plugin Development" package and a recent Qt version. These can be installed either via the official binary installer or via the [`setup.py`](setup.py) script. The latter method allows you to adjust the target Qt Creator version via [`versions.yaml`](versions.yaml).
To build the Qt Creator plugin, you will need Qt Creator, the matching "Plugin Development" package and a recent Qt version. These can be installed either via the official binary installer or via the [`install-sdk.py`](install-sdk.py) script. The latter method allows you to adjust the target Qt Creator version via [`versions.yaml`](versions.yaml).

Additionally, you need:
- OpenGL development libraries
Expand All @@ -63,20 +63,20 @@ The dependencies can be installed via apt on Ubuntu:
sudo apt install libgl1-mesa-dev ninja-build libutf8proc-dev
```

The `setup.py` script needs additional Python dependencies:
The `install-sdk.py` script needs additional Python dependencies:
```bash
pip install pyyaml requests py7zr==0.21
```

Install Qt Creator, its development files and Qt to a folder of your choice:
```sh
./setup.py --install_path ~/Downloads/
./install-sdk.py --install_path ~/Downloads/
```
The script will print the CMake commands for building the plugin and create an archive.

### Build the Plugin Archive

If Qt Creator and the Plugin Development package are not installed in one of the default folders, you have to tell CMake via `CMAKE_PREFIX_PATH` where those can be found. With the `setup.py` command above, this could be (adjust `CMAKE_PREFIX_PATH` and the Qt version if necessary):
If Qt Creator and the Plugin Development package are not installed in one of the default folders, you have to tell CMake via `CMAKE_PREFIX_PATH` where those can be found. With the `install-sdk.py` command above, this could be (adjust `CMAKE_PREFIX_PATH` and the Qt version if necessary):
```sh
cmake -B build -GNinja -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH="~/Downloads/qtc-sdk/Tools/QtCreator;~/Downloads/qtc-sdk/6.6.0/gcc_64"
cmake --build build --target package
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Run ROS Qt Creator setup script

.. code-block:: bash
./setup.py
./install-sdk.py
.. Note:: The script will download the official binary distributions of Qt and Qt Creator and thus will only support commonly used architectures. If you want to build the plugin on unsupported architectures, you have to build them from source or use a Linux distribution that provides sufficiently new versions of these packages.

Expand Down
File renamed without changes.

0 comments on commit 5732c35

Please sign in to comment.