docs: add introduction

isabelroses · Jan 1, 2025 · a3e3405 · a3e3405
1 parent 4394254
commit a3e3405
Showing 1 changed file with 29 additions and 0 deletions.
diff --git a/docs/src/README.md b/docs/src/README.md
@@ -0,0 +1,29 @@
+<div align="center">
+  <h1>isabel's dotfiles</h1>
+
+  <img alt="stars" src="https://img.shields.io/github/stars/isabelroses/dotfiles?color=f5c2e7&labelColor=303446&style=for-the-badge&logo=starship&logoColor=f5c2e7" />
+  <img alt="ci" src="https://img.shields.io/github/actions/workflow/status/isabelroses/dotfiles/check.yml?label=build&color=a6e3a1&labelColor=303446&style=for-the-badge&logo=github&logoColor=a6e3a1" />
+  <img alt="repo size" src="https://img.shields.io/github/repo-size/isabelroses/dotfiles?color=fab387&labelColor=303446&style=for-the-badge&logo=github&logoColor=fab387" />
+  <img alt="license" src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=GPL-3&logoColor=ca9ee6&colorA=313244&colorB=cba6f7" />
+  <img alt="nixos-unstable" src="https://img.shields.io/badge/NixOS-unstable-blue.svg?style=for-the-badge&labelColor=303446&logo=NixOS&logoColor=white&color=91D7E3" />
+</div>
+
+### Foreword
+
+This repository contains my **personal** configuration for my systems, so its really important that you know it's **personal** and not everything will fit your needs.
+Therefore most things will not work out of the box without some changes, so be warned!!!!
+
+> [!WARNING]
+> Also to note that this configuration will **not** work if you do not change any of the [secrets](./secrets) since they are encrypted.
+
+### What does this repo provided
+
+- Several applications and tools for my needs, but you can choose the one that best suits your needs
+  - `neovim`, `micro` and `vscode` for text editing
+  - `firefox` and `chromium` for web browsing
+  - `alacritty`, `kitty` and `wezterm` for terminal emulators
+  - `bash`, `zsh`, `fish` and `nushell` for shells
+- Modular configuration, so you can add or remove parts of the configuration
+- Sensible defaults, so you can get started quickly
+- Docs kind of
+- [Catppuccin](https://github.com/catppuccin/catppuccin) everywhere, with a hint of [evergarden](https://github.com/comfysage/evergarden)