carch
Carch Documentation
Carch is a user-friendly Bash script that simplifies the setup process for Arch and Arch-based Linux systems. This documentation serves as a guide for using, contributing to, and understanding the features of Carch.
Table of Contents
- Introduction
- Features
- Installation
- Aur Installation
- Usage
- Roadmap
- Contributing
- Code of Conduct
- License
- Contact
- Acknowledgments
Introduction
Carch aims to automate and streamline the initial setup of Arch Linux, making it easier for users to configure their systems efficiently. The script encompasses various setup tasks, including package installations, theme configurations, and window manager setups.
Features
- Easy Setup: Quick and straightforward installation of essential packages.
- TUI Navigation: A text-based user interface that enhances user experience.
- Multiple Scripts: Automate the setup of various environments, including Dwm and Hyprland.
- Active Development: Continuous updates and new features based on community feedback.
Installation
To install Carch, execute the following command in your terminal:
bash <(curl -L https://chalisehari.com.np/carch)
Aur
You can easily install Carch as it’s available as a package:
Carch Installation Guide
To install Carch on Arch Linux, follow these steps:
git clone https://aur.archlinux.org/carch.git
cd carch
makepkg -si
For a simpler installation, use an AUR Helper like yay or paru:
paru -S carch
Just replace paru with the name of your preferred AUR helper.
Using Carch
To run Carch after installation, simply execute the following command in your terminal:
carch
Important:
This script is primarily designed for Arch and Arch-based systems. Support for additional distributions will be added in future updates.
Usage
Upon running the installation script, Carch provides a menu-driven interface for various setup options:
- Arch Setup: Automated configuration of the Arch Linux environment.
- AUR Setup: Options to install your preferred AUR helper (e.g., Paru, Yay).
- Theme & Icon Setup: Customize your desktop with themes and icons.
Follow the on-screen instructions to navigate through the menu.
Roadmap
For information on upcoming features and improvements, check the full roadmap here:
View the Roadmap
Contributing
Contributions are welcome! To contribute to Carch, follow these steps:
- Fork the repository.
- Create a new feature branch.
- Make your changes.
- Commit your changes with a descriptive message.
- Push to the branch.
- Submit a pull request.
Please refer to the CONTRIBUTING.md for more details.
Code of Conduct
We strive to create a welcoming environment for all contributors. Please read our Code of Conduct to ensure a positive experience for everyone involved.
License
Carch is licensed under the Apache-2.0 License. For more details, see the LICENSE file.
Contact
If you have any questions or suggestions, feel free to reach out via:
- 📧 Email: ingoprivate@gmail.com
- GitHub: harilvfs
Acknowledgments
We thank everyone who has contributed to making Carch better. Your feedback and contributions are invaluable!
Repository Structure
carch/
├── build/
│ └── carch
├── docs/
│ └── index.md
├── preview/
│ ├── carchp.png
│ └── carchp1.png
├── scripts/
│ ├── Dwm Setup.sh
│ ├── Hyprland Setup.sh
│ ├── Install Fonts.sh
│ ├── Install LTS Kernel.sh
│ ├── Install Packages.sh
│ ├── README.txt
│ ├── Setup Alacritty.sh
│ ├── Setup Aur.sh
│ ├── Setup Fastfetch.sh
│ ├── Setup GRUB.sh
│ ├── Setup Kitty.sh
│ ├── Setup Neovim.sh
│ ├── Setup Picom.sh
│ ├── Setup Rofi.sh
│ ├── Setup SDDM.sh
│ ├── Setup Themes-Icons.sh
│ └── Wallpapers.sh
├── INSTALLATION.md
├── LICENSE
├── PKGBUILD
├── README.md
├── SECURITY.md
├── binarybuild.sh
├── carch.desktop
├── roadmap.md
├── cxfs.sh
├── run.sh
└── setup.sh
Thank you for exploring Carch!