-Script optimization - organization

README.md

@@ -1,54 +1,121 @@
-## Overview of ChrisTitusTech's `.bashrc` Configuration
+# ChrisTitusTech's `.bashrc` Configuration
 
-The `.bashrc` file is a script that runs every time a new terminal session is started in Unix-like operating systems. It is used to configure the shell session, set up aliases, define functions, and more, making the terminal easier to use and more powerful. Below is a summary of the key sections and functionalities defined in the provided `.bashrc` file.
+## Overview
 
-## How to install
-```
+This repository provides a comprehensive `.bashrc` configuration along with supporting scripts and configuration files to enhance your terminal experience in Unix-like operating systems. It configures the shell session by setting up aliases, defining functions, customizing the prompt, and more, significantly improving the terminal's usability and power.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Uninstallation](#uninstallation)
+- [Configuration Files](#configuration-files)
+  - [.bashrc](#bashrc)
+  - [starship.toml](#starshiptoml)
+  - [config.jsonc](#configjsonc)
+- [Key Features](#key-features)
+- [Advanced Functions](#advanced-functions)
+- [System-Specific Configurations](#system-specific-configurations)
+- [Conclusion](#conclusion)
+
+## Installation
+
+To install the `.bashrc` configuration, execute the following commands in your terminal:
+
+```sh
 git clone --depth=1 https://github.com/ChrisTitusTech/mybash.git
 cd mybash
-chmod +x setup.sh
 ./setup.sh
 ```
 
-### Initial Setup and System Checks
+The `setup.sh` script automates the installation process by:
+
+- Creating necessary directories (`linuxtoolbox/mybash`)
+- Cloning the repository
+- Installing dependencies (bash-completion, neovim, starship, fzf, zoxide)
+- Installing the MesloLGS Nerd Font required for the prompt
+- Linking configuration files (`.bashrc` and `starship.toml`) to your home directory
+- Setting up additional utilities like `fastfetch`
+
+Ensure you have the required permissions and a supported package manager before running the script.
+
+## Uninstallation
+
+To uninstall the `.bashrc` configuration, run:
+
+```sh
+cd mybash
+chmod +x uninstall.sh
+./uninstall.sh
+```
+
+The `uninstall.sh` script reverses the installation process by:
+
+- Removing installed dependencies
+- Uninstalling fonts
+- Removing symbolic links to configuration files
+- Deleting the `linuxtoolbox` directory
+- Cleaning up additional utilities like `starship`, `fzf`, and `zoxide`
+
+After running the script, it's recommended to restart your shell to apply the changes.
+
+## Configuration Files
+
+### `.bashrc`
+
+The `.bashrc` file defines aliases, functions, and environment variables to enhance your shell experience. Key features include:
+
+- **Aliases**: Shortcuts for common commands (e.g., `alias cp='cp -i'`)
+- **Functions**: Custom functions for tasks like extracting archives and copying files with progress
+
+### `starship.toml`
+
+The `starship.toml` file configures the [Starship](https://starship.rs/) prompt, providing a highly customizable and informative shell prompt. It includes:
 
-- **Environment Checks**: The script checks if it is running in an interactive mode and sets up the environment accordingly.
-- **System Utilities**: It checks for the presence of utilities like `fastfetch`, `bash-completion`, and system-specific configurations (`/etc/bashrc`).
+- **Theme Settings**: Defines colors and symbols for different prompt segments
+- **Module Configurations**: Customizes modules like `python`, `git`, `docker_context`, and various programming languages
+- **Format Customization**: Structures the layout and truncation of paths for a cleaner look
 
-### Aliases and Functions
+### `config.jsonc`
 
-- **Aliases**: Shortcuts for common commands are set up to enhance productivity. For example, `alias cp='cp -i'` makes the `cp` command interactive, asking for confirmation before overwriting files.
-- **Functions**: Custom functions for complex operations like `extract()` for extracting various archive types, and `cpp()` for copying files with a progress bar.
+The `config.jsonc` file configures [fastfetch](https://github.com/AlexRogalskiy/fastfetch), a system information tool. It includes:
 
-### Prompt Customization and History Management
+- **Logo and Display Settings**: Customizes the appearance of system logos and separators
+- **Modules**: Defines which system information modules to display, such as CPU, GPU, OS, kernel, and uptime
+- **Custom Sections**: Adds custom formatted sections for hardware and software information
 
-- **Prompt Command**: The `PROMPT_COMMAND` variable is set to automatically save the command history after each command.
-- **History Control**: Settings to manage the size of the history file and how duplicates are handled.
+## Key Features
 
-### System-Specific Aliases and Settings
+1. **Aliases and Functions**
+   - Shortcuts for common commands
+   - Custom functions for complex operations (e.g., extracting archives, copying with progress)
 
-- **Editor Settings**: Sets `nvim` (NeoVim) as the default editor.
-- **Conditional Aliases**: Depending on the system type (like Fedora), it sets specific aliases, e.g., replacing `cat` with `bat`.
+2. **Prompt Customization and History Management**
+   - Configures PROMPT_COMMAND for automatic history saving
+   - Manages history file size and handles duplicates
 
-### Enhancements and Utilities
+3. **Enhancements and Utilities**
+   - Improves command output readability with colors
+   - Introduces safer file operations (e.g., using `trash` instead of `rm`)
+   - Integrates Zoxide for easy directory navigation
 
-- **Color and Formatting**: Enhancements for command output readability using colors and formatting for tools like `ls`, `grep`, and `man`.
-- **Navigation Shortcuts**: Aliases to simplify directory navigation, e.g., `alias ..='cd ..'` to go up one directory.
-- **Safety Features**: Aliases for safer file operations, like using `trash` instead of `rm` for deleting files, to prevent accidental data loss.
-- **Extensive Zoxide support**: Easily navigate with `z`, `zi`, or pressing Ctrl+f to launch zi to see frequently used navigation directories.
+4. **Installation and Configuration Helpers**
+   - Auto-installs necessary utilities based on system type
+   - Provides functions to edit important configuration files
 
-### Advanced Functions
+## Advanced Functions
 
-- **System Information**: Functions to display system information like `distribution()` to identify the Linux distribution.
-- **Networking Utilities**: Tools to check internal and external IP addresses.
-- **Resource Monitoring**: Commands to monitor system resources like disk usage and open ports.
+- System information display
+- Networking utilities (e.g., IP address checks)
+- Resource monitoring tools
 
-### Installation and Configuration Helpers
+## System-Specific Configurations
 
-- **Auto-Install**: A function `install_bashrc_support()` to automatically install necessary utilities based on the system type.
-- **Configuration Editors**: Functions to edit important configuration files directly, e.g., `apacheconfig()` for Apache server configurations.
+- Editor settings (NeoVim as default)
+- Conditional aliases based on system type
+- Package manager-specific commands
 
-### Conclusion
+## Conclusion
 
-This `.bashrc` file is a comprehensive setup that not only enhances the shell experience with useful aliases and functions but also provides system-specific configurations and safety features to cater to different user needs and system types. It is designed to make the terminal more user-friendly, efficient, and powerful for an average user.
+This `.bashrc` configuration offers a powerful and customizable terminal environment suitable for various Unix-like systems. It enhances productivity through smart aliases, functions, and integrated tools while maintaining flexibility for system-specific needs. Whether you're a developer, system administrator, or power user, this setup aims to make your terminal experience more efficient and enjoyable.
 
+For any issues, suggestions, or contributions, please open an issue or pull request in this repository. We welcome community involvement to make this configuration even better!