Qt Project Creator CLI

A command-line tool to quickly set up a Qt project with customizable options written in javascript.

Installation

Install the tool globally using npm:

npm install -g qt-project-creator

Usage

Run the tool to create a new Qt project:

qt-project-creator

Options

• Options: --init Initializes a default "hello-world-qt" project with cmake.

Example

To create a new Qt project interactively:

1. Run the CLI tool:

qt-project-creator

2. Follow the prompts to set up your project, including selecting Qt version, build system, and whether to include a widget.ui file.

Project Structure

The tool creates the following structure:

|project-name/
│
├── headers/
│ └── widget.h
│
├── src/
│ ├── main.cpp
│ └── widget.cpp
│
├── ui/ # (Optional) Contains .ui files if selected
│ └── widget.ui
│
├── README.md
├── LICENSE
├── CMakeLists.txt # CMake build file (if cmake is selected)
└── project-name.pro # Qt project file (if qmake is selected)

Build and Run

Manual

To build and run the project manually:

cd <project-name>
mkdir build && cd build && qmake && make
cd .. && ./build/<project-name>

Using script

To build and run using the generated script:

cd <project-name>
./run.sh  # On Windows use run.bat

License

Copyright 2024 Raj Kashyap

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.