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.
- 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
You can find the latest release of faircmd on our Releases page. Hereβs how to get started:
- Visit the Releases page.
- Find the latest version of faircmd.
- Look for the appropriate file for your system (e.g., .zip or .tar.gz).
- Click the file link to start downloading.
Once you have downloaded the file, unzip it to a location of your choice.
If you prefer to build faircmd from source, follow these steps:
- Make sure you have a C++ compiler installed.
- Clone this repository using the command:
git clone https://github.com/Mulugojam137/faircmd.git - Navigate to the faircmd directory:
cd faircmd - Build the project. You can type the following command:
make
This will create the executable files needed to run your tests.
Using faircmd is intuitive. Hereβs a basic guide:
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;
}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.
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.
faircmd is relevant for users interested in:
- CI (Continuous Integration)
- Command queue management
- Testing and validation of software
- Concurrency
- Deterministic test execution
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.
We welcome contributions! If you'd like to help improve faircmd, please follow these steps:
- Fork the repository.
- Create a new branch.
- Make your changes.
- Submit a pull request.
Your feedback and contributions are highly valued.
faircmd is open-source software, licensed under the MIT License. Feel free to use, modify, and share.
Thank you for using faircmd! Happy testing!