From c7b8073f7192553860d8a4bb1fbf6bdf7a1ffaa1 Mon Sep 17 00:00:00 2001 From: Baipyrus Date: Mon, 26 Aug 2024 21:03:12 +0200 Subject: [PATCH] general README design and explanations --- PowerShell/README.md | 15 ++++++++++++++- README.md | 22 +++++++++++++++++++++- alacritty/README.md | 26 +++++++++++++++++++++++++- alacritty/catppuccin-latte | 1 + alacritty/catppuccin-mocha | 1 + nerd-fonts/CascadiaCode | 1 + nerd-fonts/CascadiaMono | 1 + nerd-fonts/README.md | 21 ++++++++++++++++++++- nvim/README.md | 25 +++++++++++++++++++++++++ nvim/nvim | 1 + nvim/nvim-modular | 1 + 11 files changed, 111 insertions(+), 4 deletions(-) create mode 100644 alacritty/catppuccin-latte create mode 100644 alacritty/catppuccin-mocha create mode 100644 nerd-fonts/CascadiaCode create mode 100644 nerd-fonts/CascadiaMono create mode 100644 nvim/nvim create mode 100644 nvim/nvim-modular diff --git a/PowerShell/README.md b/PowerShell/README.md index 9eff752..d428a5c 100644 --- a/PowerShell/README.md +++ b/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. diff --git a/README.md b/README.md index d23d95a..c0334c0 100644 --- a/README.md +++ b/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 +``` diff --git a/alacritty/README.md b/alacritty/README.md index 8d4fef9..18fe987 100644 --- a/alacritty/README.md +++ b/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. diff --git a/alacritty/catppuccin-latte b/alacritty/catppuccin-latte new file mode 100644 index 0000000..d493031 --- /dev/null +++ b/alacritty/catppuccin-latte @@ -0,0 +1 @@ +https://github.com/catppuccin/alacritty/raw/main/catppuccin-latte.toml diff --git a/alacritty/catppuccin-mocha b/alacritty/catppuccin-mocha new file mode 100644 index 0000000..d2450d6 --- /dev/null +++ b/alacritty/catppuccin-mocha @@ -0,0 +1 @@ +https://github.com/catppuccin/alacritty/raw/main/catppuccin-mocha.toml diff --git a/nerd-fonts/CascadiaCode b/nerd-fonts/CascadiaCode new file mode 100644 index 0000000..9c8b28b --- /dev/null +++ b/nerd-fonts/CascadiaCode @@ -0,0 +1 @@ +https://github.com/ryanoasis/nerd-fonts/releases/latest/download/CascadiaCode diff --git a/nerd-fonts/CascadiaMono b/nerd-fonts/CascadiaMono new file mode 100644 index 0000000..84cad87 --- /dev/null +++ b/nerd-fonts/CascadiaMono @@ -0,0 +1 @@ +https://github.com/ryanoasis/nerd-fonts/releases/latest/download/CascadiaMono diff --git a/nerd-fonts/README.md b/nerd-fonts/README.md index e230074..3a872d6 100644 --- a/nerd-fonts/README.md +++ b/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. diff --git a/nvim/README.md b/nvim/README.md index 2293847..3ac472c 100644 --- a/nvim/README.md +++ b/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/ + ``` diff --git a/nvim/nvim b/nvim/nvim new file mode 100644 index 0000000..3eb9db9 --- /dev/null +++ b/nvim/nvim @@ -0,0 +1 @@ +https://github.com/Baipyrus/nvim-config.git diff --git a/nvim/nvim-modular b/nvim/nvim-modular new file mode 100644 index 0000000..d1be164 --- /dev/null +++ b/nvim/nvim-modular @@ -0,0 +1 @@ +https://github.com/dam9000/kickstart-modular.nvim.git