{"id":24374611,"url":"https://github.com/ucalgary-rover/ssrt-telemetry","last_synced_at":"2025-10-03T20:33:20.305Z","repository":{"id":271971714,"uuid":"915132705","full_name":"ucalgary-rover/SSRT-Telemetry","owner":"ucalgary-rover","description":"Qt Quick-based application designed to display real-time data from multiple sensors operated by the Rover.","archived":false,"fork":false,"pushed_at":"2025-03-22T16:52:51.000Z","size":1154,"stargazers_count":2,"open_issues_count":4,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-22T17:36:07.133Z","etag":null,"topics":["cpp","qml","qtquick"],"latest_commit_sha":null,"homepage":"","language":"QML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ucalgary-rover.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-11T03:54:44.000Z","updated_at":"2025-03-22T16:52:25.000Z","dependencies_parsed_at":"2025-03-01T19:30:03.895Z","dependency_job_id":"fb18e1eb-f767-4f0d-87ef-6fa9e17cbb52","html_url":"https://github.com/ucalgary-rover/SSRT-Telemetry","commit_stats":null,"previous_names":["ucalgary-rover/ssrt-telemetry"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ucalgary-rover%2FSSRT-Telemetry","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ucalgary-rover%2FSSRT-Telemetry/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ucalgary-rover%2FSSRT-Telemetry/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ucalgary-rover%2FSSRT-Telemetry/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ucalgary-rover","download_url":"https://codeload.github.com/ucalgary-rover/SSRT-Telemetry/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248279644,"owners_count":21077407,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cpp","qml","qtquick"],"created_at":"2025-01-19T05:40:52.293Z","updated_at":"2025-10-03T20:33:15.287Z","avatar_url":"https://github.com/ucalgary-rover.png","language":"QML","readme":"# SSRTelemetry\n\nQt application built for sensor visual interface with processing capabilities.\n\n## Running Linux build\n\n### First install essential build tools for Qt Development\n\n#### On Ubuntu\n\nInstall make and other build tools like gcc:\n\n```bash\nsudo apt install build-essential.\nsudo apt install cmake.\n```\n\n### Building and Running on Qt Creator\n\nThe base application can be run in Qt Creator GUI simply by opening the CMakelists.txt file witin the project folder. Qt Creator may or may not need to be configured to detect build tool executables. For some systems it may auto detect the bin executables (make, cmake etc.) for you.\n\n### Building and running manually with CMake\n\nWill require a version of CMake (A cross platform build system that creates makefiles), make (Compiles and builds C/C++ files) and GNU Build tools.\n\nThe typical way to build manually is by first creating a directory in the project folder itself. Run `mkdir build`.\n\nChange directory to the build\n\n```bash\ncd build\n```\n\nRun CMake\n\n```bash\ncmake ...\n```\n\nThis will create the build in the build folder and use the CMakeLists.txt found in the parent directory.\n\nThen run make to compile:\n\n```bash\nmake\n```\n\nThe application can be run with\n\n```bash\n./appSSRTelemetry\n```\n\n## Before contributing\n\nPrecommit runs basic formatters and linters to enforce code formatting standards.\n\n### Setting Up Pre-Commit\n\nTo ensure consistent code quality and enforce standards, we use **pre-commit** hooks. Follow the steps below to install and verify it:\n\n### Installation\n\n#### On Windows\n\nInstall pre-commit using pip:\n\n```bash\npip install pre-commit\n```\n\n#### On Ubuntu Linux\n\nCreate and activate a virtual environment and install pre-commit within it.\n\n```bash\n# Create a virtual environment\npython3 -m venv ~/.venvs/myenv\n\n# Activate the virtual environment\nsource ~/.venvs/myenv/bin/activate\n\n# Install the package\npip install pre-commit\n```\n\nOR\n\nInstall pre-commit using pip:\n\n```bash\nsudo apt install python3-pip\npip3 install pre-commit\n```\n\n#### On Arch Linux\n\nInstall pre-commit using pip:\n\n```bash\nsudo pacman -S pre-commit\n```\n\n### Verification\n\n_You may need to refresh the terminal for precommit install to take effect_\n\nAfter installation, verify the installation by checking the version:\n\n```bash\npre-commit --version\n```\n\nUpdate if needed:\n\n```bash\npre-commit autoupdate\n```\n\nIf you see the expected version, pre-commit is successfully installed and ready to use!\n\nTo initalize pre-commit hooks on a repository. Change directory into repository directory and run:\n\n```bash\npre-commit install\n```\n\n### Linters and Static Analyzers\n\nThis repo uses basic language agnostic cleanup tools provided by pre-commit, clang-format to enforce LLVM code standard and cpp check to detect small bugs in C++ code.\n\nYou only need to install clang-format and cpp check.\n\n### Installing clang-format\n\n#### Ubuntu\n\n```bash\nsudo apt install clang-format\n```\n\n### Installing cppcheck\n\n#### Ubuntu\n\n```bash\nsudo apt install cppcheck\n```\n\n### Testing precommit\n\nTo test precommit execution run:\n\n```bash\npre-commit run --all-files\n```\n\nIf your code passes all tests then it is commit ready.\n\n## Writing documentation the Doxygen way for C++\n\nSee resources for guidelines to writing documentation that is doxygen compatible\n\n## Running Doxygen build manually\n\n### Install Doxygen\n\nDoxygen simplifies code documentation process\n\n#### On Windows\n\nVisit doxygen download page https://www.doxygen.nl/download.html\n\n#### On Arch Linux\n\nInstall Doxygen using the package manager:\n\n```bash\nsudo pacman -S doxygen\n```\n\n#### On Ubuntu\n\nInstall Doxygen using apt:\n\n```bash\nsudo apt update\nsudo apt install doxygen\n```\n\n### Generate documentation\n\nGenerate documentation manually\n\n```bash\ndoxygen Doxyfile\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fucalgary-rover%2Fssrt-telemetry","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fucalgary-rover%2Fssrt-telemetry","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fucalgary-rover%2Fssrt-telemetry/lists"}