Rdevs Documentation
Welcome to the Rdevs documentation! This guide will help you understand how to install, use, and contribute to the Rdevs project.
Table of Contents
Installation
To get started with Rdevs, follow these steps:
- Install Rust:
If you don’t have Rust installed, you can do so with the following command:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
- Clone the Repository:
Clone the Rdevs repository to your local machine:
git clone https://github.com/your_username/rdevs.git
- Navigate to the Project Directory:
Change into the project directory:
cd rdevs
- Build the Project:
Use Cargo to build the project:
cargo build
- Run the Project:
You can run the project using:
cargo run
Usage
After installing Rdevs, you can use it to set up your system and run various scripts.
Main Menu
When you run Rdevs, you will see the main menu with the following options:
- Arch Setup: Use this option to install packages and configure your Arch Linux system.
- Hyprland Setup: Use this option to set up the Hyprland window manager.
- Help & Info: Displays help information about using Rdevs.
- Exit: Closes the application.
Running a Setup
To run a setup, simply navigate to the desired option using the arrow keys and press Enter.
Contributing to Rdevs
We welcome contributions! Please follow these steps to contribute to Rdevs:
- Fork the Repository: Click the “Fork” button on the top right of the repository page.
- Make Changes: Clone your fork and make changes to the code.
- Test Your Changes: Ensure that your changes do not produce any errors.
- Run the following commands to enhance your code:
cargo fmt --all
cargo clippy
cargo check
- Create a Pull Request: Once you’re satisfied with your changes, submit a pull request to the main repository.
Troubleshooting
Here are some common issues you might encounter while using Rdevs and their solutions:
Issue: Rust Not Installed
Solution: Follow the installation instructions to install Rust.
Issue: Errors During Build
Solution: Make sure your Rust installation is up-to-date and try running:
cargo update
Issue: Project Not Running
Solution: Ensure you are in the project directory and try running:
cargo run
Changelog
Version 1.0.0
- Initial release of Rdevs with basic functionality for system setup.