Skip to content

πŸš€ Run C++ scripts easily with faircmd, a header-only library for deterministic and interactive test harnesses, offering three efficient modes.

License

Notifications You must be signed in to change notification settings

Mulugojam137/faircmd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

15 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸŽ‰ faircmd - Run Your Tests Easily and Effectively

πŸ“₯ Download Now

Download faircmd

πŸš€ Getting Started

Welcome to faircmd! This application provides tiny, header-only C++ script runners that help you manage concurrent and state-machine tests. Whether you are working on Continuous Integration (CI) or want to handle user input interactively, faircmd makes the process straightforward.

πŸ–₯️ System Requirements

  • Operating System: Windows, macOS, or Linux
  • C++ Compiler: Ensure you have a C++ compiler installed (e.g., GCC, Clang, MSVC)
  • Basic knowledge of command line operations

πŸ“¦ Download & Install

You can find the latest release of faircmd on our Releases page. Here’s how to get started:

  1. Visit the Releases page.
  2. Find the latest version of faircmd.
  3. Look for the appropriate file for your system (e.g., .zip or .tar.gz).
  4. Click the file link to start downloading.

Once you have downloaded the file, unzip it to a location of your choice.

πŸ› οΈ Building faircmd from Source (Optional)

If you prefer to build faircmd from source, follow these steps:

  1. Make sure you have a C++ compiler installed.
  2. Clone this repository using the command:
    git clone https://github.com/Mulugojam137/faircmd.git
    
  3. Navigate to the faircmd directory:
    cd faircmd
    
  4. Build the project. You can type the following command:
    make
    

This will create the executable files needed to run your tests.

πŸ“– How to Use faircmd

Using faircmd is intuitive. Here’s a basic guide:

1. Prepare Your Test Script

Create a C++ script to define the tests you want to run. Here’s a simple example:

#include "faircmd.h"

int main() {
    // Your test logic here
    return 0;
}

2. Running Your Tests

To run your tests, navigate to the directory where your script is located in your command line interface, then execute:

faircmd your_script.cpp

This command will initiate the script and run your tests according to the defined logic.

βš™οΈ Features

faircmd comes with several features to accommodate various testing needs:

  • FIFO Support: Ensure tests run in a strict first-in-first-out order using the FIFO method.
  • Hybrid Input: Interactively accept user input alongside queue-based commands, perfect for manual testing scenarios.
  • State Machines: Manage state transitions smoothly, making your test harness more reliable.
  • Header-only Library: Easy integration into your existing C++ projects without complex installations.

πŸ“ Topics Covered

faircmd is relevant for users interested in:

  • CI (Continuous Integration)
  • Command queue management
  • Testing and validation of software
  • Concurrency
  • Deterministic test execution

🚧 Troubleshooting

If you run into issues:

  • Ensure you have the correct version for your OS.
  • Check your C++ compiler settings.
  • Review the script for logical errors.

For further assistance, consider visiting forums or communities around C++ testing.

πŸ”— Useful Links

πŸ™Œ Contributing

We welcome contributions! If you'd like to help improve faircmd, please follow these steps:

  1. Fork the repository.
  2. Create a new branch.
  3. Make your changes.
  4. Submit a pull request.

Your feedback and contributions are highly valued.

🏷️ License

faircmd is open-source software, licensed under the MIT License. Feel free to use, modify, and share.

Thank you for using faircmd! Happy testing!

About

πŸš€ Run C++ scripts easily with faircmd, a header-only library for deterministic and interactive test harnesses, offering three efficient modes.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •