Installation Guide

Alterix can be installed on your system using either the normal installation or the Docker installation. Please follow the appropriate steps based on your preference:

Normal Installation

1. Download: Visit the GitHub releases page for Alterix.

2. Choose Platform: Download the appropriate ZIP file for your operating system:

   • Windows
   • Linux
   • macOS

3. Extract: After the download is complete, extract the contents of the ZIP file to a directory of your choice.

4. Add to PATH: Add the directory containing the Alterix executable to your system's PATH environment variable. This step allows you to run Alterix from any location in the command line.

   Note: If you are not familiar with adding directories to the PATH, you can search online for platform-specific instructions.

5. Verify Installation: Open a new command prompt or terminal window and run the following command to verify the installation:

   alterix --help
   

If the installation was successful, the command will display the help message for Alterix.

Docker Installation

You can also use Docker to run Alterix in a containerized environment. This method is useful if you don't want to install Alterix directly on your system or if you prefer a more isolated and portable approach.

Here's how to set up Alterix using Docker:

1. Clone the Repository: If you haven't done so already, clone the Alterix repository to your local machine:

   git clone https://github.com/mtnmunuklu/alterix.git
   

2. Navigate to Docker Directory: Go to the docker directory inside the cloned repository:

   cd tools
   

3. Build Docker Image and Start Container: Use the setup script to build the Docker image named alterix-image:

   ./setup_docker_alterix.sh

   This script will handle the building of the Docker image and starting the container for you.

Congratulations! You have successfully installed Alterix on your system. Now you can proceed to the Usage section to learn how to use Alterix.