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
* Update 'Features' section
* Add git-for-windows to 'Requirements' section
* Remove note from 'Sourcing' section
* Update aliases list
* Improve explanation in 'Customization' section
  • Loading branch information
Hdoc1509 committed Nov 25, 2022
1 parent 9f38dc7 commit 1ff7746
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@ This repository hosts my configuration for `git-bash` that comes bundled with [g

## Features

- Enable symlink
- `Mintty` as terminal emulator
- Enabled symlink
- Custom prompt themes via [oh-my-posh](https://ohmyposh.dev/docs/themes)
- Plugins, aliases and functions from [shell-fns](https://github.com/Hdoc1509/shell-fns#plugins)

## Requirements

- [git-for-windows](https://gitforwindows.org/) with `mintty` as terminal emulator.
- [shell-fns](https://github.com/Hdoc1509/shell-fns#installation)
- [oh-my-posh](https://ohmyposh.dev/docs/installation/windows#installation) with manual installation

Expand All @@ -31,8 +33,6 @@ git clone --depth 1 https://github.com/Hdoc1509/git-bash-config.git ~/.config/gi
source ~/.config/git-bash/main.sh
```

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

- Be sure to source `~/.bashrc` file from your `~/.bash_profile` file:

```sh
Expand All @@ -47,12 +47,11 @@ mklink %userprofile%\.minttyrc %userprofile%\.config\git-bash\.minttyrc

## Built-in aliases

| Alias | Description |
| ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| gbCfg | Change directory to `~/.config/git-bash` and open editor setted in `SF_EDITOR` variable |
| gbCfgU | Update your local copies of `git-bash-config` and `shell-fns`. You will need to restart `git-bash` |
| new | Open a new window of `git-bash` in current directory. This alias is affected by [`SF_START_DEV_FOLDER`](https://github.com/Hdoc1509/shell-fns/tree/master/plugins/dev#settings) variable of `dev` plugin from `shell-fns`. |
| srcBash | Source your `~/.bashrc` file |
| Alias | Description |
| ------- | -------------------------------------------------------------------------------------------------- |
| gbCf | Change directory to `~/.config/git-bash` and open editor setted in `SF_EDITOR` variable |
| gbCfU | Update your local copies of `git-bash-config` and `shell-fns`. You will need to restart `git-bash` |
| srcBash | Source your `~/.bashrc` file |

## Customization

Expand All @@ -70,7 +69,7 @@ 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.
- [Configurations for shell-fns](https://github.com/Hdoc1509/shell-fns#usage) must be at the end of `main.sh`.

## My other software configurations

Expand Down

0 comments on commit 1ff7746

Please sign in to comment.