Skip to content

Commit

Permalink
Support For Fedora Linux (#14)
Browse files Browse the repository at this point in the history
Co-authored-by: aayush <[email protected]>
Co-authored-by: Smriti Bhandari <[email protected]>
Co-authored-by: aayushxvf <[email protected]>
  • Loading branch information
4 people authored Feb 8, 2025
1 parent 4404fe2 commit 71e22a0
Show file tree
Hide file tree
Showing 7 changed files with 43 additions and 166 deletions.
1 change: 0 additions & 1 deletion docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ export default {
{ text: "Introduction", link: "/getting-started/introduction" },
{ text: "Installation", link: "/installation/cli" },
{ text: "Commands", link: "/installation/cmd" },
{ text: "TUI", link: "/installation/tui" },
{ text: "Overview Scripts", link: "/scripts/scripts" },
{ text: "Roadmap", link: "/github/roadmap" },
{ text: "Contributing", link: "/github/contributing" },
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

<h1>What is Carch?</h1>

**Carch** is a simple `Bash script` designed to simplify the process of setting up an `Arch` Linux system. With an intuitive menu interface powered by `gum`, Carch makes configuring your system as easy and efficient as possible, saving you valuable time.
**Carch** is a simple `Bash` script designed to simplify the process of setting up an `Arch Linux` or `Fedora` system. With an intuitive menu interface powered by `gum`, **Carch** makes configuring your system as easy and efficient as possible, saving you valuable time.


## Features
Expand Down Expand Up @@ -45,7 +45,7 @@
## Commands Support
<img src="https://img.icons8.com/?size=80&id=114423&format=png" width="50" />

- **Carch CLI**
- **Carch Commands**
*A command-line interface is also included for handling various instructions and tasks.*

**With Carch, you can effortlessly handle all basic tasks and system setups. Feedback is always welcome, and we look forward to hearing from you!**
Expand Down
48 changes: 17 additions & 31 deletions docs/github/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,10 @@
- Refactor existing scripts for improved stability.
- Implement error handling and logging for better debugging.

- **Improve TUI (Text-based User Interface) 🎨**
- Enhance user experience with better navigation and visuals.
- Add more themes and customization options.
- Integrate user feedback for continuous improvement.

- **Implement Additional Programming Languages** <img src="https://img.icons8.com/?size=64&id=t7vIvDXazOGO&format=png" width="20" />
- Add Rust implementations for performance-critical components.
- Explore opportunities for parallel development in Rust.
- **Remove TUI Development and Rust Integration 🚫**
- Dropping the development of the TUI (Text-based User Interface) in favor of simplifying user experience.
- Rust will no longer be used in this project for TUI-related components.
- Focus will shift to maintaining and enhancing shell scripts for a more lightweight and efficient setup process.

- **Add Window Manager (WM) Setup Scripts 🪟**
- Create and improve installation/setup scripts for more window managers (e.g., i3, Sway).
Expand All @@ -37,18 +33,14 @@
- Develop beginner-friendly scripts for core system setup (e.g., package management, user configuration).
- Include guides and documentation to assist new users.

- **Enhance TUI with Rust 🦀**
- Transition the TUI implementation to Rust for improved performance and maintainability.
- Leverage Rust's features to create a more responsive interface.

## Carch Project Checklist
<img src="https://cdn-icons-png.flaticon.com/128/8090/8090840.png" width="30" />

- **Expand support for popular distributions:**

- Arch <img src="https://img.icons8.com/?size=48&id=uIXgLv5iSlLJ&format=png" width="20" /> <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />
- Arch <img src="https://img.icons8.com/?size=48&id=uIXgLv5iSlLJ&format=png" width="20" /> <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />
- Fedora <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />
- Debian <img src="https://cdn-icons-png.flaticon.com/128/190/190406.png" width="20" />
- Fedora <img src="https://cdn-icons-png.flaticon.com/128/190/190406.png" width="20" />
- openSUSE <img src="https://cdn-icons-png.flaticon.com/128/190/190406.png" width="20" />
- Void <img src="https://cdn-icons-png.flaticon.com/128/190/190406.png" width="20" />

Expand All @@ -57,37 +49,31 @@
- Implement error handling <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />
- Add logging capabilities <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />

- **Improve TUI:**

- Enhance Navigation <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />
- Add themes/customizations <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />
- Gather user feedback <img src="https://cdn-icons-png.flaticon.com/128/190/190406.png" width="20" />
- **Remove TUI Development and Rust Integration 🚫:**


- **Implement additional programming languages:**

- Develop Rust components <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />
- Assess areas for parallel development <img src="https://cdn-icons-png.flaticon.com/128/190/190406.png" width="20" />
- Drop development of the TUI (Text-based User Interface). <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />
- Remove Rust-based components for the TUI. <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />
- Focus on improving the shell script setup experience. <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />

- **Add WM setup scripts:**

- i3 setup script <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />
- DWM setup script <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />
- Sway setup script <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />
- Other window manager scripts <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />
- Hyprland window manager scripts <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />
- Bspwm setup script <img src="https://cdn-icons-png.flaticon.com/128/190/190406.png" width="20" />
- River setup script <img src="https://cdn-icons-png.flaticon.com/128/190/190406.png" width="20" />
- Wayfire setup script <img src="https://cdn-icons-png.flaticon.com/128/190/190406.png" width="20" />
- DWL Setup setup script <img src="https://cdn-icons-png.flaticon.com/128/190/190406.png" width="20" />

- **Create core system setup scripts:**

- User configuration <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />
- Package management <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />
- Documentation for beginners <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />

- **Transition TUI to Rust:**
- Research best practices for TUI development in Rust <img src="https://cdn-icons-png.flaticon.com/128/190/190406.png" width="20" /> [ongoing]
- Implement and test new TUI <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />

## Timeline (Tentative) 📅

- **Q 2024**: Develop additional WM setup scripts and core system setup scripts. <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />
- **Q 2025**: Rust Implementation <img src="https://cdn-icons-png.flaticon.com/128/190/190411.png" width="20" />
- **Q Mid 2025/2026**: Refactor existing scripts for stability and begin expanding distribution support. [If possible] <img src="https://cdn-icons-png.flaticon.com/128/190/190406.png" width="20" />
- **Q Mid 2025/2026**: Refactor existing scripts for stability and begin expanding distribution support (including Fedora ✅). [If possible] <img src="https://cdn-icons-png.flaticon.com/128/190/190406.png" width="20" />

10 changes: 5 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ pageClass: home-page

hero:
name: Carch
text: "Automate Your Arch Linux Setup"
text: "Automate Your Linux Setup"
image:
src: /carch.png
alt: Linux logo
style: "width: 200px; height: auto;"
tagline: A simple Bash script for quick, efficient, and preconfigured Arch Linux system setup 🧩
tagline: A simple Bash script for quick, efficient, and preconfigured Linux system setup (Arch & Fedora) 🧩
actions:
- theme: brand
text: What is Carch?
Expand All @@ -24,9 +24,9 @@ features:
- icon: <img width="35" height="35" src="https://cdn-icons-png.flaticon.com/128/10229/10229090.png" alt="setup"/>
title: Easy Setup
details: Quick and straightforward installation of essential packages.
- icon: <img width="35" height="35" src="https://cdn-icons-png.flaticon.com/128/7425/7425907.png" alt="tui"/>
title: TUI Navigation
details: A text-based user interface that enhances user experience.
- icon: <img width="35" height="35" src="https://img.icons8.com/?size=100&id=ZbBhBW0N2q3D&format=png&color=000000" alt="fedora"/>
title: Fedora
details: Adds full support for Fedora Linux, alongside Arch-based systems, with tailored setup scripts.
- icon: <img width="35" height="35" src="https://cdn-icons-png.flaticon.com/128/3131/3131638.png" alt="scripts"/>
title: Multiple Scripts
details: Automate the setup of various environments, including Dwm and Hyprland.
Expand Down
10 changes: 4 additions & 6 deletions docs/installation/cmd.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,9 @@ Options:
--gen-config Generate a default configuration file in ~/.config/carch/carch.conf.
--config <conf dir> Use a specific configuration file to load selected scripts.
-c Use the default configuration file to load selected scripts.
--run-script <name>, -r Run the specified script from /usr/bin/scripts.
--list-scripts, -l List all available scripts in /usr/bin/scripts.
--run-script <name>, -r Run the specified script from /usr/share/scripts.
--list-scripts, -l List all available scripts in /usr/share/scripts.
--update Update Carch using the latest script.
--tui, -t Launch the TUI interface.
--uninstall Uninstall Carch and remove all associated files.
```
:::
Expand All @@ -34,10 +33,9 @@ Options:
- `--gen-config` *Generate a default configuration file in ~/.config/carch/carch.conf.*
- `--config <conf dir>` *Use a specific configuration file to load selected scripts.*
- `-c` *Use the default configuration file to load selected scripts.*
- `--run-script <name>, -r` *Run the specified script from /usr/bin/scripts.*
- `--list-scripts, -l` *List all available scripts in /usr/bin/scripts.*
- `--run-script <name>, -r` *Run the specified script from /usr/share/scripts.*
- `--list-scripts, -l` *List all available scripts in /usr/share/scripts.*
- `--update` *Update Carch using the latest script.*
- `--tui, -t` *Launch the TUI interface.*
- `--uninstall` *Uninstall Carch and remove all associated files.*

Example config:
Expand Down
119 changes: 0 additions & 119 deletions docs/installation/tui.md

This file was deleted.

17 changes: 15 additions & 2 deletions docs/scripts/scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<img src="https://cdn-icons-png.flaticon.com/128/3721/3721643.png" width="40" />

**Carch comes with the following scripts to configure various aspects of your Arch-based system.**
**Carch comes with the following scripts to configure various aspects of your Arch-based system or Fedora system.**

### Dwm
- *Quickly sets up the Dwm window manager with a single-click script, using my customized configuration.*
Expand Down Expand Up @@ -53,10 +53,23 @@
- *Installs and applies a set of themes and icons to enhance the look and feel of your desktop.*

### SwayWM
- *Installs and configures the Sway window manager, optimized for Wayland environments.*
- *Currently not compatible with Fedora. SwayWM is supported for Arch-based systems only.*

### Wallpapers
- *Installs a selection of wallpapers for a personalized desktop aesthetic.*

### Tmux
- *Installs and configures Tmux for a more efficient terminal multiplexing experience.*

### Helix
- *Installs and configures the Helix text editor, providing a modern and feature-rich code editing environment optimized for both performance and ease of use.*

### Bash Promt
- *Sets up a custom Bash prompt with useful information such as the current working directory, Git status, and system details, enhancing the command line experience.*

### Zsh Promt
- *Configures a stylish Zsh prompt with added functionalities like syntax highlighting, auto-completion, and custom themes for a more efficient shell experience.*

### Fish
- *Installs and configures the Fish shell, offering an interactive and user-friendly command-line environment with advanced features such as auto-suggestions and a clean syntax.*

0 comments on commit 71e22a0

Please sign in to comment.