Skip to content

Commit 2a3dc10

Browse files
authored
Use Markdown alerts
1 parent 90967f3 commit 2a3dc10

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,9 @@ Preinstalled `grep` in FreeBSD doesn't support Perl regular expressions. Solutio
126126
* The default powerline should already be visible now!
127127
4. Continue to the [Configuration](#configuration) section below.
128128
129-
Note that tpm plugins should be at the bottom of you `tmux.conf`. This plugin will then override some tmux settings like `status-left`, `status-right` etc. If you had already set those in your tmux config, it is a good opportunity to remove or comment those out.
130-
Take a look at [main.tmux](https://github.com/erikw/tmux-powerline/blob/main/main.tmux) for exactly which settings are overridden.
129+
> [!NOTE]
130+
> Note that tpm plugins should be at the bottom of you `tmux.conf`. This plugin will then override some tmux settings like `status-left`, `status-right` etc. If you had already set those in your tmux config, it is a good opportunity to remove or comment those out.
131+
> Take a look at [main.tmux](https://github.com/erikw/tmux-powerline/blob/main/main.tmux) for exactly which settings are overridden.
131132
132133
133134
# Configuration
@@ -159,7 +160,8 @@ cp ~/.config/tmux/plugins/tmux-powerline/themes/default.sh ~/.config/tmux-powerl
159160
$EDITOR ~/.config/tmux-powerline/themes/my-theme.sh
160161
```
161162

162-
Remember to update the configuration file to use the new theme by setting `TMUX_POWERLINE_THEME=my-theme`
163+
> [!IMPORTANT]
164+
> Remember to update the configuration file to use the new theme by setting `TMUX_POWERLINE_THEME=my-theme`
163165
164166
## Custom segments
165167
In the same was as themes, you can create your own segments at `TMUX_POWERLINE_DIR_USER_SEGMENTS` which defaults to `~/.config/tmux-powerline/segments`.
@@ -208,27 +210,30 @@ Be sure to search in the [resolved issues](https://github.com/erikw/tmux-powerli
208210

209211

210212

211-
## Common problems
213+
## Common Problems
212214
### Nothing is displayed
213215
You have edited `~/.tmux.conf` but no powerline is displayed. This might be because tmux is not aware of the changes so you have to restart your tmux session or reloaded that file by typing this on the command-line (or in tmux command mode with `prefix :`)
214216

215217
```shell
216218
tmux source-file ~/.tmux.conf
217219
```
220+
218221
### Multiple lines in bash or no powerline in Zsh using iTerm (macOS)
219222
If your tmux looks like [this](https://github.com/erikw/tmux-powerline/issues/125) then you may have to in iTerm uncheck [Unicode East Asian Ambiguous characters are wide] in Preferences -> Settings -> Advanced.
220223

224+
221225
# Hacking (Development)
222226
This project can only gain positively from contributions. Fork today and make your own enhancements and segments to share back! If you'd like, add your name and email to AUTHORS before making a pull request so you can get some credit for your work :-)
223227

224228
## Codespaces Devcontainer
225229
You can fork this project and then start coding right away with GitHub Codespaces as this project is set up to install all development dependencies and install tmux-powerline on the devcontainer. See [devcontainer.json](.devcontainer/devcontainer.json) and [devcontainer_postCreateCommand.sh](scripts/devcontainer_postCreateCommand.sh). After starting the devcontainer, just type `tmux` in the terminal and you should see a working tmux-powerline already to start playing with.
226230

227-
Note: if you have set up your own dotfiles to be installed with GitHub Codespaces, and there was some tmux config files installed from your dotfiles to the devcontainer, then you might have to run this script to wipe your config in favour of the setup provided by this repo's initialization:
228-
229-
```shell
230-
./scripts/devcontainer_postCreateCommand.sh
231-
```
231+
> [!IMPORTANT]
232+
> If you have set up your own dotfiles to be installed with GitHub Codespaces, and there was some tmux config files installed from your dotfiles to the devcontainer, then you might have to run this script to wipe your config in favour of the setup provided by this repo's initialization:
233+
>
234+
> ```shell
235+
> ./scripts/devcontainer_postCreateCommand.sh
236+
> ```
232237
233238
## How to make a segment
234239
If you want to (of course you do!) send a pull request for a cool segment you written make sure that it follows the style of existing segments, unless you have good reason for it. Each segment resides in the `segments/` directory with a descriptive and simple name.
@@ -240,7 +245,8 @@ Usage of helper function to organize the work of a segment is encourage and shou
240245
explanation of the setting and its values. Study e.g. `segments/now_playing.sh` to see how it is done. A segment having settings should typically call a helper function `__process_settings` as the first statement in `run_segment` that sets default values
241246
to the settings that has not been set by the user.
242247
243-
Also, don't use bash4 features as requiring bash4 complicates installation for macOS user quite a bit. Use tabs for indentation ([discussion](https://github.com/erikw/tmux-powerline/pull/92)),
248+
> [!IMPORTANT]
249+
> Also, don't use bash4 features as requiring bash4 complicates installation for macOS user quite a bit. Use tabs for indentation ([discussion](https://github.com/erikw/tmux-powerline/pull/92)),
244250
245251
# Releasing
246252
Create a new version of this project by using [semver-cli](https://github.com/maykonlsf/semver-cli).

0 commit comments

Comments
 (0)