Skip to content

Installation_Guide.md

Latest commit

 

History

History
105 lines (67 loc) · 2.67 KB

Installation_Guide.md

File metadata and controls

105 lines (67 loc) · 2.67 KB

Tarian Detector Installation Guide

Welcome to the step-by-step installation guide for Tarian Detector. This guide will help you install and run Tarian Detector on your local machine.

Prerequisites

Before starting, ensure you have the following dependencies installed on your system:

  • Go programming language (version 1.22 or higher)
  • Clang compiler
  • LLVM
  • libelf development library
  • libbpf development library
  • Linux kernel headers
  • Linux tools (matching your kernel version)
  • bpftool utility

You can install these dependencies by running the following command:

Install Project Dependencies

make install

Clone the Repository

Clone the Tarian Detector repository to your local machine:

git clone https://github.com/intelops/tarian-detector
cd tarian-detector

Building Tarian Detector

After you've successfully cloned the repository and installed the necessary dependencies, it's time to build the project.

Navigate to the root directory of Tarian Detector:

cd tarian-detector

Then build the project using the provided Makefile:

make build

Running Tarian Detector

You've successfully built the project! Now, you can run Tarian Detector on your machine:

sudo make run

Development and Testing

For development purposes, the Makefile provides a helpful command to build and run the application in one step:

make dev_run

To ensure your code adheres to our standards and does not contain any issues, use our linting tools:

make fmt    # Run go fmt to format Go code
make lint   # Run linting with revive and staticcheck for Go code

This command executes go fmt, go vet, and additional linting tools against your code.

Create a File with License and Copyright Details

To create a new file with license and copyright details, run:

make file FILE_PATH=/your/file/path/filename.ext

Uninstall

If you ever want to uninstall Tarian Detector and remove its dependencies, run:

make uninstall

Clean-Up

If you want to clean up the project and remove object files, run:

make clean

That's it! You have successfully installed Tarian Detector and can now use it to detect whatever it is designed for. Please note that the specific functionalities and details of Tarian Detector may vary based on the actual project. Always refer to the project's documentation for more information on its usage and capabilities.

Wrapping Up

Congratulations! You've successfully installed and run Tarian Detector on your local system. For any questions or issues, please refer to the Troubleshooting and FAQs or Contact Us. We're here to help!