Skip to content
This repository has been archived by the owner on Aug 29, 2023. It is now read-only.

Commit

Permalink
Docs: Update docs
Browse files Browse the repository at this point in the history
* Remove clone via 'tiged'
* Improve explanation in Customization section
* Add section 'Update git-bash-config'
  • Loading branch information
Hdoc1509 committed Nov 15, 2022
1 parent bfb6920 commit 0f3a865
Showing 1 changed file with 20 additions and 11 deletions.
31 changes: 20 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,12 @@ This repository hosts my configuration for `git-bash` that comes bundled with [g

### Cloning

Clone this repository into your user-specific configurations folder: `$HOME/.config`.

- Via `git clone`:
Clone this repository into your user-specific configurations folder: `$HOME/.config`:

```sh
git clone --depth 1 https://github.com/Hdoc1509/git-bash-config.git ~/.config/git-bash
```

- Via [tiged](https://github.com/tiged/tiged#installation):

```sh
tiged Hdoc1509/git-bash-config ~/.config/git-bash
```

### Sourcing

- Source entry file in your `~/.bashrc` file:
Expand All @@ -57,20 +49,37 @@ mklink %userprofile%\.minttyrc %userprofile%\.config\git-bash\.minttyrc

All configurations must be placed in `~/.config/git-bash/main.sh` file.

- For set an `oh-my-posh` theme you should use `set_posh_theme` or `set_custom_theme`:
- For set an `oh-my-posh` theme you should use `set_posh_theme` or `set_custom_theme` functions:

```sh
# For oh-my-posh built-in themes
set_posh_theme tokyonight_storm

# For custom themes
# For oh-my-posh custom themes
set_custom_theme blue-owl-mod
```

**Note:** [Custom themes](/custom-themes/) have the suffix `-mod`.

- [Configurations for shell-fns](https://github.com/Hdoc1509/shell-fns#usage) must be at the end.

## Update git-bash-config

- Run the following commands for update your local copies of `git-bash-config` and `shell-fns`:

```sh
git -C ~/.config/git-bash pull
git -C ~/.config/shell-fns pull
```

- Or run the following built-in alias:

```sh
gbCfgU
```

All updates will take effect after restarting `git-bash`.

## My other software configurations

- [nvim-config](https://github.com/Hdoc1509/nvim-config)
Expand Down

0 comments on commit 0f3a865

Please sign in to comment.