mio/easyzsh
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated Readme.md

Browse Source
This commit is contained in:
JGill
2020-02-06 16:05:34 +10:30
parent 2f215c1995
commit 36655a87b2
1 changed files with 13 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@@ -2,7 +2,6 @@
A simple script to setup an awesome shell environment. A simple script to setup an awesome shell environment.
Quickly install and setup zsh and oh-my-zsh (https://github.com/robbyrussell/oh-my-zsh) with Quickly install and setup zsh and oh-my-zsh (https://github.com/robbyrussell/oh-my-zsh) with
* powerlevel10k theme (https://github.com/romkatv/powerlevel10k) * powerlevel10k theme (https://github.com/romkatv/powerlevel10k)
* Powerline fonts(https://github.com/powerline/fonts)
* Nerd-Fonts (even better!) (https://github.com/ryanoasis/nerd-fonts) * Nerd-Fonts (even better!) (https://github.com/ryanoasis/nerd-fonts)
* zsh-completions (https://github.com/zsh-users/zsh-completions) * zsh-completions (https://github.com/zsh-users/zsh-completions)
* zsh-autosuggestions (https://github.com/zsh-users/zsh-autosuggestions) * zsh-autosuggestions (https://github.com/zsh-users/zsh-autosuggestions)
@@ -14,15 +13,15 @@ Quickly install and setup zsh and oh-my-zsh (https://github.com/robbyrussell/oh-
* todotxt (https://github.com/todotxt/todo.txt-cli) * todotxt (https://github.com/todotxt/todo.txt-cli)
Sets following useful aliases: Sets following useful aliases:
* l="ls -lah" - just type "l" instead of "ls -lah" * l="ls -lah" - just type "l" instead of "ls -lah"
* alias k="k -h" - show human readable filesizes, in kb, mb etc * alias k="k -h" - show human readable filesizes, in kb, mb etc
* x="exit" * x="exit"
* https - make httpie use https * https - make httpie use https
* wip - (wget -qO- https://wtfismyip.com/text) what's my ip: quickly find out external IP * wip - (wget -qO- https://wtfismyip.com/text) - what's my ip: quickly find out external IP
* cheat - (https://github.com/chubin/cheat.sh) cheatsheets in the terminal! * cheat - (https://github.com/chubin/cheat.sh) - cheatsheets in the terminal!
* speedtest - (curl -s https://raw.githubusercontent.com/sivel/speedtest-cli/master/speedtest.py | python3 -) run speedtest on the fly * speedtest - (curl -s https://raw.githubusercontent.com/sivel/speedtest-cli/master/speedtest.py | python3 -) run speedtest on the fly
* dadjoke - (curl https://icanhazdadjoke.com) terminally sick jokes * dadjoke - (curl https://icanhazdadjoke.com) - terminally sick jokes
* dict - (curl "dict://dict.org/d:$1 $2 $3") dictionary definitions * dict - (curl "dict://dict.org/d:$1 $2 $3") - dictionary definitions
## Demo ## Demo
@@ -39,25 +38,21 @@ Watch this to get an idea of what your Shell (well, life!) could be like!!
## Installation ## Installation
Requirements: Requirements:
* `git` to clone it. * `git` to clone it.
* `python3` or `python` is required to run option '--cp-hist' * `python3` or `python` is required to run option '-c' which copies history from .bash_history
``` bash ``` bash
git clone https://github.com/jotyGill/quickz-sh.git git clone https://github.com/jotyGill/quickz-sh.git
cd quickz-sh cd quickz-sh
./quickz.sh ./quickz.sh -c # only run with '-c' the first time, running multiple times will duplicate history entries
```
First time run it with '--cp-hist' instead, to copy command history from .bash_history to .zsh_history.
``` bash
./quickz.sh --cp-hist # running multiple times will duplicate history entries
``` ```
Change your terminals fonts to either "RobotoMono Nerd Font" or "Hack Nerd Font" or at least on of the "Powerline Fonts". Change your terminals fonts to either "RobotoMono Nerd Font" or "Hack Nerd Font" or "DejaVu Sans Mono Nerd Fonts".
You can also manually install Nerd Font of your choice. You can also manually install Nerd Fonts of your choice.
## Notes ## Notes
* If you are already using zsh, your zsh config will be backed up to .zshrc-backup * If you are already using zsh, your zsh config will be backed up to .zshrc-backup-date
* If the text/icons look broken, make sure your terminal is using one of the Nerd fonts or at least powerline fonts. [discussion](https://github.com/powerline/fonts/issues/185). I recommend "RobotoMono Nerd Font" * If the text/icons look broken, make sure your terminal is using one of the Nerd fonts. [discussion](https://github.com/powerline/fonts/issues/185). I recommend "RobotoMono Nerd Font"
* marker's shortcut "Ctr+t" clashed with fzf so I rebound it to "Ctr +b" * marker's shortcut "Ctr+t" clashed with fzf so I rebound it to "Ctr +b"