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 developer walkthrough for IDE setup #5573

Merged
merged 3 commits into from
Aug 26, 2024
Merged
Changes from 2 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
45 changes: 45 additions & 0 deletions doc/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,3 +237,48 @@ Before commiting, install pre-commit to auto-format your code.
pip install pre-commit
pre-commit install
```

## Developer Walkthrough for Linux

The commands below are using `apt`, so they are written for Debian based systems like Ubuntu. Adapt accordingly for other distributions.

### Initial Setup

1. **Clone the Source Code:**
- Use `git` to clone the repository from GitHub.

2. **Install Required Tools:**
- Install Qt Creator, a compiler, and other dependencies:
```bash
sudo apt update
sudo apt install qtcreator build-essential
```

#### Build

1. **Build from Command Line:**
- Run the convenience script to build the project:
```bash
./scripts/build-for-linux.sh
```

2. **Resolve Dependencies:**
- If the build fails, check the error output for missing dependencies and install them as recommended.

#### Setup the IDE

1. **Open Qt Creator:**
- Launch Qt Creator from your application menu or terminal.

2. **Setup Qt Installation:**
- Go to `Preferences -> Kits -> Qt Versions -> Add`.
- Select `qmake` from `build-x64-linux/vcpkg_installed/x64-linux/tools/Qt6/bin/qmake`.

3. **Create a New Kit:**
- Add a new kit in the `Kits` tab, selecting the newly added Qt version.

4. **Create a New Project:**
- Open the `CMakeLists.txt` file from the source code directory.
- Select the newly created kit with a Debug configuration, pointing to the `build-x64-linux` directory.

You are now ready to develop and run the project using Qt Creator!
Loading