Giter VIP home page Giter VIP logo

cnc_gui's Introduction

CnC_GUI

This is prerelease software, and as such is highly unstable.

CnC_GUI is a graphical interface for running Chips and Cheese benchmark tools. The intention is to make it easier for our readers to utilise our tools on hardware they own so that we can gather more data as part of our database of results (as found here).

Usage

Disclaimer: The CnC_GUI application is currently not statically compiled. This means that it requires libraries to be able to run. We currently ship the libraries packaged in the ZIP folder with our Windows builds, however for Linux there are instructions below on installation of dependencies. We intend in future to ship a Flatpak package for Linux platforms to reduce the steps required to use the application.

Windows

For users on Windows, please extract the ZIP file as is and navigate to the CnC GUI directory, then the build folder located within. Once within this folder, double click CnC_GUI.exe to open the application. The application does not require administrator privileges and we recommend against running as administrator at this time.

Linux

As of the time of writing, the application is not statically linked and requires the installation of a number of dependencies. The application has been tested on Ubuntu 22.04 and Arch Linux.

We are working on developing a Flatpak package to reduce installation complexity. As a result, until this is available, we shall be delaying the release of pre-compiled versions of the application for Linux.

Dependencies

The CnC_GUI is currently built using Qt 6.3.1 and requires the installation of these libraries to function. We recommend that you install the Qt Creator IDE and build the application from source, as installing the libraries separately is a very complex process.

License

CnC_GUI is available under the terms of the Apache-2.0 license.

Authors

Copyright © 2022 Chips and Cheese

cnc_gui's People

Contributors

mohamexiety avatar nexus2345 avatar nintonito avatar serebit avatar

Stargazers

avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar

Forkers

serebit maxhaton

cnc_gui's Issues

Create Flatpak package for Linux installations

Trying to install Qt 6 on Linux is an absolute nightmare, and the only way to install it in a consistent and repeatable manner is to install their IDE which uses 8+ GB of disk space. As a result, we need to create a Flatpak (or similar) package for our Linux users so that they can use the application easier.

Windows and Linux cross-platform builds and releases

Enable cross-platform builds and releases for both Windows and Linux for the GUI

@Nintonito could you please comment with some details on what is left to do on this?

TO DO

  • Ship Linux build using .tar.gz with execute permissions on binaries
  • Update readme with instructions for installing dependencies on Linux
  • Fix relative path issues for Linux (@serebit)

Automate build pipelines

We need to create a set of automated build pipelines to enable us to do proper gating of PRs. These pipelines should compile the code for Windows and Linux at a minimum to establish that submitted changes are free of compilation errors and following this we can add additional steps such as automated tests or security tooling.

Create proper README for project

We need to create a proper README for the project which outlines what it is, how to install and use it, how to contribute and any other necessary information.

Implement branch protection for main

We need to establish a baseline for what checks code submitted via PRs should have to pass to be submitted to the main branch. This is achieved through the use of protected branches within the GitHub environment. Code at a minimum should pass the below gates before being merged into the repo.

Gates

  • Successfully compiles for Linux and Windows (and other supported platforms if and when added)
  • Does not introduce security vulnerabilities (as confirmed via CodeQL and Dependabot)
  • Is reviewed by at least one of the primary maintainers
  • Contributor has agreed to follow the license

Debug mode for GUI

It will aid future development and troubleshooting by adding a debug mode of some kind to the GUI that does not rely on debug tools found in IDEs or external tools. This is only going to be pretty basic to start with and print out values being executed to ensure that things like paths and file permissions are being set correctly.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.