Skip to content

Commit

Permalink
docs: update README.md (#5)
Browse files Browse the repository at this point in the history
* update docs

* Update screenshots in README.md
  • Loading branch information
wxharry authored Jul 20, 2022
1 parent dece705 commit 87c1310
Show file tree
Hide file tree
Showing 2 changed files with 544 additions and 47 deletions.
74 changes: 27 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

My dotfiles settings. zsh+oh-my-zsh+tmux+vim.

## Screenshots

![Snipaste_2022-07-20_14-56-51](https://user-images.githubusercontent.com/39271899/180076060-fe9502b8-67b9-4179-88fc-39633cd36994.png)

![Snipaste_2022-07-20_16-32-46](https://user-images.githubusercontent.com/39271899/180076314-16024c38-d8f9-4da3-970d-311fbd9ebaf6.png)


## Prerequisite
Expand All @@ -17,38 +22,18 @@ My dotfiles settings. zsh+oh-my-zsh+tmux+vim.
git clone https://github.com/wxharry/dotfiles.git && cd dotfiles && ./install
```

## Questions
**no such file or directory: $HOME/.oh-my-zsh/oh-my-zsh.sh**
Install oh-my-zsh
``` bash
wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh
sh install.sh
```
**[oh-my-zsh] theme 'powerlevel10k/powerlevel10k' not found**
Install p10k
``` bash
git clone --depth=1 https://github.com/romkatv/powerlevel10k.git ${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/themes/powerlevel10k
```

## Windows Terminal

### Windows(WSL)
* Windows Terminal (recommended)
* cmd
* powershell

### Theme
You can pick up one theme on [windows terminal themes](https://windowsterminalthemes.dev/). By clicking the `get theme` button below, you could easily copy and paste the theme to the `settings.json` in Windows Terminal. (I am currently using `Relaxed`)

## Theme (Windows Terminal)
You can pick up a theme at [windows terminal themes](https://windowsterminalthemes.dev/). Click the `get theme` button below to copy the style and paste it to the `settings.json` in Windows Terminal. (currently using `BlulocoDark`)


## Shell

I am currently using [zsh](https://www.zsh.org/).
Currently using [zsh](https://www.zsh.org/).

I also installed [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh) to manage my zsh configuration. oh-my-zsh have a lot of themes, you can pick one in [Themes in ohmyzsh](https://github.com/ohmyzsh/ohmyzsh/wiki/Themes).
Installed [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh) to manage my zsh configuration. oh-my-zsh have a lot of themes, you can pick a style you like in [Themes in ohmyzsh](https://github.com/ohmyzsh/ohmyzsh/wiki/Themes).

The theme I am currently using is [powerlevel10k](https://github.com/romkatv/powerlevel10k) and I highly recommend it. p10k is easy to install and configure.
I am using [powerlevel10k](https://github.com/romkatv/powerlevel10k) and highly recommend it. It is easy to install and configure.

### Tips

Expand All @@ -57,17 +42,14 @@ The theme I am currently using is [powerlevel10k](https://github.com/romkatv/po
2. After editing `.zshrc`, use `source ~/.zshrc` to update zsh.



## Tmux

I mixed some of tmux theme schemes and self-made this style.
Mixed with some of tmux theme schemes and self-made this style.

I installed [tpm](https://github.com/tmux-plugins/tpm) as my tmux plugin manager.
Installed [tpm](https://github.com/tmux-plugins/tpm) as my tmux plugin manager.

All the plugins are in `tmux/.tmux/plugin`.

I want to keep my dotfile simple, so there are only a few plugins.

### Tips

1. Default color in tmux is 8 colors. You could use `echo $TERM` to see the difference.
Expand All @@ -80,27 +62,25 @@ I want to keep my dotfile simple, so there are only a few plugins.

## vim

I am using the default color scheme in vim. (I tried to add and change color schemes, but the default one fit the best.)
I am using the default color scheme in vim.

I installed [vim-plug](https://github.com/junegunn/vim-plug) to manage vim plugins.
Installed [vim-plug](https://github.com/junegunn/vim-plug) to manage vim plugins.

All the vim plugins are in `vim/.vim/plugged`. Color schemes can either be installed as a plugin with vim-plug or download to `vim/.vim/colors`.


## To do

[See details](https://github.com/wxharry/dotfiles/projects/1)



## Screenshots

![Snipaste_2021-06-28_23-10-11](https://user-images.githubusercontent.com/39271899/123660402-35742500-d866-11eb-8975-d96571820f3f.png)



![Snipaste_2021-06-26_idk](https://user-images.githubusercontent.com/39271899/123531238-90f2c580-d735-11eb-9dcc-84d4fdfdc959.jpg)
Use `PlugInstall!` and `PlugUpdate!` to install and update plugins in vim.


## Trouble Shooting
**no such file or directory: $HOME/.oh-my-zsh/oh-my-zsh.sh**
Install oh-my-zsh
``` bash
wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh
sh install.sh
```
**[oh-my-zsh] theme 'powerlevel10k/powerlevel10k' not found**
Install p10k
``` bash
git clone --depth=1 https://github.com/romkatv/powerlevel10k.git ${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/themes/powerlevel10k
```

![Snipaste_2021-06-26_22-37-18](https://user-images.githubusercontent.com/39271899/123531206-407b6800-d735-11eb-9cca-b28eb7d84281.png)
Loading

0 comments on commit 87c1310

Please sign in to comment.