🚧 warning: For detailed information about how to use witch_craft
run witch_craft h or witch_craft --help.
The project initially includes a set of default files. These files are created using the best possible data analysis techniques, and their final versions are merged into the main project.
It consists of two main components:
- witch_craft for CLI application.
- witch_oracle for GUI application
To build the project, follow these instructions:
Step 1: Clone the Repository
git clone https://github.com/th3Maid/witch_craft.git --branch=trunk --depth 1
cd witch_craft
Step 2: Run the Build Script
Execute the provided build script build.sh:
chmod +x build.sh
./build.sh
The script will prompt you to enter the root password, create a folder called release, and place the built executables inside it. Step 3: Explore the Release Folder
Navigate to the release folder to find the built components:
- witch_craft: The cli application executable.
- witch_oracle: The gui application executable.
Usage
After building the project, you can run each component individually. Here's a brief overview:
Running Witch_Craft
Execute the following command to run the witch_craft application:
./release/witch_craft
Running Witch Oracle
To visualize data, run the Witch Oracle application:
./release/witch_oracle
Feel free to contribute to witch_craft by submitting issues or pull requests. Your input is valuable!
This project is licensed under the GNU General Public License v3.0.