Mathis/dotfiles
1
0
Fork 0
mirror of https://github.com/lordmathis/dotfiles.git synced 2025-11-05 17:24:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md for clarity and consistency in installation instructions

Browse Source
This commit is contained in:
Matúš Námešný
2025-09-27 21:01:19 +02:00
parent 5a6f293d90
commit d80b03d354
1 changed files with 13 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -1,6 +1,6 @@
# 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
@@ -8,16 +8,22 @@ My dotfiles. If you want to use them fork or clone the repo. Each branch has spe
## 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
* `echo ".dotfiles" >> .gitignore`
* `git clone --bare git@github.com:LordMathis/dotfiles.git $HOME/.dotfiles`
* `alias config='/usr/bin/git --git-dir=$HOME/.dotfiles/ --work-tree=$HOME'`
* `config checkout <branch-name>`
* `git clone --bare git@github.com:lordmathis/dotfiles.git $HOME/.dotfiles`
* `function config { /usr/bin/git --git-dir=$HOME/.dotfiles/ --work-tree=$HOME "$@"; }`
* `config checkout common`
* `config submodule init`
* `config submodule update`
* `config submodule update --recursive --remote`
* `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/)**