seb/dotfiles
1
0
Fork 0
mirror of https://github.com/sebaschi/dotfiles.git synced 2025-11-08 23:14:27 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Heavily update README.md. Especially mention new install script and also just better format the whole thing. Disclamer: Claude Caude wrote the thing mostly, I just made some changes to wording and corrected things it got wrong.

Browse Source
This commit is contained in:
Sebastian Lenzlinger 2025-04-12 15:20:04 +02:00
parent fd7a7745a8
commit 890b5f6a76
1 changed files with 54 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
README.md
View File

@ -1,25 +1,58 @@
# Some Notes
__ To be worked into a setup script at some point __
## Clone repo
```
# Dotfiles
A collection of configuration files for various tools and applications I use, with an installation script to easily set them up on new systems.
## Installation
### Clone the repository
```bash
git clone git@github.com:sebaschi/dotfiles.git ~/.dotfiles
```
{
## Symlink files to correct locations
```
ln -s ~/.dotfiles/git/gitconfig ~/.gitconfig
```
```
ln -s ~/.dotfiles/vim/vimrc ~/.vimrc
```
```
ln -s ~/.dotfiles/bash/bashrc ~/.bashrc
```
## Apps/Tools I use
* 'exa' as replacement for 'ls'
* starship.io
* 'neofetch' CLI for system (OS mostly) info
* 'ncdu" CLI disk use info
* 'htop' process/cpu info. replacement for 'top'
* neovim with lazy.nvim
### Install configurations
The `dot-install` script can be used to install specific configurations or all of them at once:
```bash
# Install everything
~/.dotfiles/dot-install all
# Install specific configurations
~/.dotfiles/dot-install git nvim tmux
# Install only bash aliases
~/.dotfiles/dot-install bash:aliases
```
Run `~/.dotfiles/dot-install` without arguments to see all available options.
## Testing
A test script is included to verify the installation script works correctly:
```bash
~/.dotfiles/test-dot-install
```
This runs the installation in an isolated environment to ensure all symlinks are correctly created.
## Included Configurations
* **Shells**: Bash, Fish, Zsh
* **Terminal**: Tmux, Zellij, Ghostty
* **Editors**: Vim, Neovim (with lazy.nvim)
* **Tools**: Git, Starship prompt, Borg backup
* **Utilities**: Rsync filters
## Tools Tools
* `eza` - Modern replacement for `ls`
* `starship.io` - Cross-shell prompt
* `neofetch` - System information tool
* `ncdu` - Disk usage analyzer
* `btop` - Interactive process viewer (replacement for `top`)
* `neovim` - Enhanced vim editor
> [!note]
> TODO: add more tools!