ZT-DE-week7-miniproject7

Rust CLI Tool User Guide

Welcome to the user guide for the Rust CLI Tool! This guide will walk you through the installation process, provide a brief overview of the tool's functionalities, and explain how to use them.

Table of Contents

• Installation
• Getting Started
• Usage
  • Basic Greeting
  • Adding Two Numbers
• Troubleshooting
• Contributions and Feedback

Installation

Prerequisites

Ensure you have git and cargo installed on your machine. If not, refer to the official Git and Rust installation guides.

Steps

1. Clone the Repository: Clone the repository to your local machine.

   git clone https://github.com/JTuratkhan/rust_cli_tool.git
   

2. Navigate to Tool's Directory: Access the directory containing the tool's code.

'''bash cd rust_cli_tool/rust_cli_tool_inside

3. Build the Tool: Build the CLI tool using cargo.

'''bash cargo build --release

Getting Started

Once you've successfully installed the tool, you're all set to explore its functionalities. The tool currently supports basic greeting and addition operations.

Usage

Basic Greeting

Command Structure:

'''bash cargo run greet [YOUR NAME]

Adding Two Numbers

Command Structure:

'''bash cargo run add [NUMBER1] [NUMBER2]

Troubleshooting

If you face any issues while using the tool:

1. Ensure you followed the installation guide correctly.
2. Make sure you're running commands from the correct directory (rust_cli_tool/rust_cli_tool_inside).
3. If problems persist, consider raising an issue on the GitHub repository.

Contributions and Feedback

Your feedback is invaluable to us! If you have suggestions, enhancements, or encounter issues, please raise them on the GitHub repository. Contributions via pull requests are also welcome.