more refinement
This commit is contained in:
36
README.md
36
README.md
@@ -24,6 +24,42 @@
|
||||
- shellcheck
|
||||
- bash-language-server
|
||||
- terraform
|
||||
- terraform-ls
|
||||
- tflint
|
||||
- ruff
|
||||
- cbonsai
|
||||
|
||||
# Git Configuration
|
||||
|
||||
This directory contains Git configuration files that can be safely shared in a
|
||||
public repository.
|
||||
|
||||
## Setup Instructions
|
||||
|
||||
1. Create a symbolic link for the main Git config:
|
||||
|
||||
```
|
||||
ln -sf ~/dotfiles/git/.gitconfig ~/.gitconfig
|
||||
```
|
||||
|
||||
2. Create your personal Git configuration:
|
||||
|
||||
```
|
||||
cp ~/dotfiles/git/.gitconfig.local.example ~/.gitconfig.local
|
||||
```
|
||||
|
||||
3. Edit `~/.gitconfig.local` with your personal information:
|
||||
```
|
||||
[user]
|
||||
name = Your Name
|
||||
email = your.email@example.com
|
||||
```
|
||||
|
||||
## Structure
|
||||
|
||||
- `.gitconfig`: Main configuration file with shareable settings
|
||||
- `.gitconfig.local.example`: Template for personal/private Git settings
|
||||
- `~/.gitconfig.local`: (Not tracked) Your personal Git configuration
|
||||
|
||||
This approach keeps your personal information out of the public repository while
|
||||
still allowing you to manage and version your Git configuration.
|
||||
|
||||
Reference in New Issue
Block a user