general README design and explanations

PowerShell/README.md

@@ -1,2 +1,15 @@
-# PowerShell configuration
+# PowerShell Configuration
 
+This directory contains my PowerShell configuration files.
+
+## Files
+
+- **Microsoft.PowerShell_profile.ps1**: This is the main PowerShell profile script.
+It contains custom aliases, functions, and environment settings.
+
+## Installation
+
+To use this configuration:
+
+1. Clone the repository.
+2. Copy the `Microsoft.PowerShell_profile.ps1` file to your PowerShell profile location.

README.md

@@ -1,2 +1,22 @@
-# dotfiles
+# Dotfiles
 
+Welcome to my `dotfiles` repository! This repository contains the configuration files
+for various programs I use. Each program's configuration is organized into its own
+directory. Below is a brief overview of the programs and configurations included.
+
+## Structure
+
+- **PowerShell**: [PowerShell configuration](./PowerShell)
+- **alacritty**: [Alacritty terminal emulator configuration](./alacritty)
+- **nerd-fonts**: [Nerd Fonts configuration](./nerd-fonts)
+- **nvim**: [Neovim configuration](./nvim)
+
+## Getting Started
+
+To use these configurations, clone this repository and symlink the necessary files
+to your home directory or the appropriate configuration directories for each program.
+Instructions for each program are provided in their respective directories.
+
+```pwsh
+git clone https://github.com/Baipyrus/dotfiles.git
+```

alacritty/README.md

@@ -1,2 +1,26 @@
-# Alacritty configuration
+# Alacritty Configuration
 
+This directory contains my Alacritty terminal emulator configuration.
+
+## Files
+
+- **alacritty.yml**: This is the main configuration file for Alacritty, containing
+settings for colors, fonts, keybindings, and more.
+- **catppuccin-mocha**: This file contains the URL to the `catppuccin-mocha` theme
+for Alacritty.
+- **catppuccin-latte**: This file contains the URL to the `catppuccin-latte` theme
+for Alacritty.
+
+## Installation
+
+To use this configuration:
+
+1. Clone the repository.
+2. Download all required themes from files:
+
+    ```pwsh
+    curl -LO "${Get-Content ./alacritty/catpuccin-mocha}"
+    ```
+
+3. Copy the `alacritty.yml` file and all downloaded themes to your Alacritty
+configuration directory.

alacritty/catppuccin-latte

@@ -0,0 +1 @@
+https://github.com/catppuccin/alacritty/raw/main/catppuccin-latte.toml

alacritty/catppuccin-mocha

@@ -0,0 +1 @@
+https://github.com/catppuccin/alacritty/raw/main/catppuccin-mocha.toml

nerd-fonts/CascadiaCode

@@ -0,0 +1 @@
+https://github.com/ryanoasis/nerd-fonts/releases/latest/download/CascadiaCode

nerd-fonts/CascadiaMono

@@ -0,0 +1 @@
+https://github.com/ryanoasis/nerd-fonts/releases/latest/download/CascadiaMono

nerd-fonts/README.md

@@ -1,2 +1,21 @@
-# Nerd Fonts configuration
+# Nerd Fonts Configuration
 
+This directory contains my Nerd Fonts configuration and any related resources.
+
+## Files
+
+- **CascadiaCode**: This file contains the URL to the `Cascadia Code` Nerd Font patch.
+- **CascadiaMono**: This file contains the URL to the `Cascadia Mono` Nerd Font patch.
+
+## Installation
+
+To use this configuration:
+
+1. Clone the repository.
+2. Download all required fonts from files:
+
+    ```pwsh
+    curl -LO "${Get-Content ./nerd-fonts/CascadiaMono}.zip"
+    ```
+
+3. Unpack and install all downloaded fonts to your system's font storage.

nvim/README.md

@@ -3,3 +3,28 @@
 This configuration varies from this here standard. The actual Neovim configuration
 can be found under a separate repository here. These files only serve as a reference
 to all configurations that are to be installed in my personal configuration.
+
+## Files
+
+- **nvim**: This file contains the URL to my personal configuration that is to be
+installed as the main configuration on the machine.
+- **nvim-modular**: This file contains the URL to the repository of `kickstart-modular.nvim`
+which is serving as a secondary configuration for debugging purposes.
+
+## Installation
+
+To use this configuration:
+
+1. Clone the repository.
+2. Download all required configurations from files:
+
+    ```pwsh
+    curl -LO "${Get-Content ./nvim/nvim}"
+    ```
+
+3. Copy the downloaded configuration to your system's specific location:
+
+    ```pwsh
+    # Powershell - Windows Location
+    Copy-Item nvim/ $env:LOCALAPPDATA/
+    ```

nvim/nvim

@@ -0,0 +1 @@
+https://github.com/Baipyrus/nvim-config.git

nvim/nvim-modular

@@ -0,0 +1 @@
+https://github.com/dam9000/kickstart-modular.nvim.git