Update README.md for clarity and consistency in installation instructions

This commit is contained in:
2025-09-27 21:01:19 +02:00
parent 5a6f293d90
commit d80b03d354

View File

@@ -1,6 +1,6 @@
# Dotfiles # Dotfiles
My dotfiles. If you want to use them fork or clone the repo. Each branch has specific dotfiles for one of my machines My dotfiles configuration for zsh, nvim, and various development tools. Works across desktop and server environments.
## Requirements ## Requirements
@@ -8,16 +8,22 @@ My dotfiles. If you want to use them fork or clone the repo. Each branch has spe
## Install ## Install
`curl https://raw.githubusercontent.com/LordMathis/dotfiles/main/install.sh | zsh -s -- <branch name>` `curl https://raw.githubusercontent.com/lordmathis/dotfiles/main/install.sh | zsh -s -- common`
## Manual install ## Manual install
* `echo ".dotfiles" >> .gitignore` * `echo ".dotfiles" >> .gitignore`
* `git clone --bare git@github.com:LordMathis/dotfiles.git $HOME/.dotfiles` * `git clone --bare git@github.com:lordmathis/dotfiles.git $HOME/.dotfiles`
* `alias config='/usr/bin/git --git-dir=$HOME/.dotfiles/ --work-tree=$HOME'` * `function config { /usr/bin/git --git-dir=$HOME/.dotfiles/ --work-tree=$HOME "$@"; }`
* `config checkout <branch-name>` * `config checkout common`
* `config submodule init` * `config submodule init`
* `config submodule update` * `config submodule update --recursive --remote`
* `source .zshrc` * `source .zshrc`
## Usage
After installation, you can:
* Manage dotfiles: `config status`, `config add .vimrc`, `config commit -m "update"`
* Update everything: `config update` (pulls latest changes and updates all submodules)
**[Full Guide](https://developer.atlassian.com/blog/2016/02/best-way-to-store-dotfiles-git-bare-repo/)** **[Full Guide](https://developer.atlassian.com/blog/2016/02/best-way-to-store-dotfiles-git-bare-repo/)**