CoreTrace Qt is DISCONTINUED coretrace-gui is its successor !

A modern Qt-based IDE for the CoreTrace project, providing a user-friendly interface for managing and analyzing traces.

Documentation

Complete documentation for this project is available online: https://coretrace.github.io/coretrace-qt/

The documentation includes:

• API Reference: Technical documentation of the codebase
• User Guide: Instructions for using the application

Features

• Modern Qt-based GUI
• File tree view with context menu support
• Project management
• Trace analysis tools
• Cross-platform support

Prerequisites

• Qt 6.x
• CMake 3.16 or higher
• C++17 compatible compiler
• Git

Required Libraries

• Qt6 Core
• Qt6 Widgets
• Qt6 Gui
• libcurl
• libssh2

Using the .sh Scripts

The project includes several shell scripts at the root level that you can use to automate various tasks:

build.sh

./build.sh

This script automates the build process. It will:

• Check for required dependencies
• Create a build directory
• Configure the project with CMake
• Build the project
• Install the executable (if specified)

clean.sh

./clean.sh

This script will clean the build directory and remove all build artifacts.

dist.sh

./dist.sh

This script creates distribution packages for the project.

test.sh

./test.sh

This script runs all unit tests for the project.

Building the Project

Linux/macOS

1. Clone the repository:

git clone https://github.com/yourusername/coretrace-qt.git
cd coretrace-qt

2. Make the build script executable:

chmod +x build.sh

3. Run the build script:

./build.sh

Building the Project with build.sh

Run the following command to build the project:

./build.sh

This will automate the build process. It will:

• Check for required dependencies
• Create a build directory
• Configure the project with CMake
• Build the project
• Install the executable (if specified)

Building the AppImage with app-image-builder.sh

If you wish to create an AppImage, use:

./app-image-builder.sh

This script helps in building an AppImage of the project for wider distribution. However, Wayland users should be aware that currently, AppImages do not work on Wayland. It's recommended to only use build.sh if you are using Wayland.

Cleaning the Repository with clean.sh

To clean the repository and remove any build artifacts, run:

./clean.sh

This will clean the build directory and remove all temporary files and build outputs.

Windows

For Windows builds, we recommend using MXE (MinGW-w64 Cross Compiler) to create a standalone executable.

1. Install MXE following their installation guide

2. Use the provided Makefile:

make -f Makefile.windows

This will create a standalone .exe file with all required dependencies.

Project Structure

coretrace-qt/
├── src/                    # Source files
├── includes/              # Header files
├── resources/             # Resources (icons, etc.)
├── build/                 # Build directory (created by build.sh)
├── CMakeLists.txt        # CMake configuration
├── Makefile              # Windows build configuration USE WITH MXE !
├── build.sh              # Build script
└── README.md             # This file

Development

Adding New Features

1. Create new source files in the src/ directory
2. Add corresponding headers in the includes/ directory
3. Update CMakeLists.txt with new files
4. Rebuild the project

Code Style

• Follow Qt coding conventions
• Use C++17 features
• Document all public interfaces
• Write unit tests for new features

Continuous Integration

The project uses GitHub Actions to automatically verify AppImage builds:

• Workflow: .github/workflows/appimage-build-test.yml
• Triggers: Push/PR to main or develop branches
• Verification: Ensures AppImage is successfully generated
• Artifacts: AppImage saved for 7 days after successful build

Local Verification

To quickly check if an AppImage was generated locally:

./check-appimage.sh

Contributing

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request

Contact

Mail: cedric.roulof@epitech.eu

Discord: shookapic (faster response)