psi-jack/zimfw
1
0
Fork 0
mirror of synced 2024-12-21 21:51:07 -05:00
Code Issues Releases Wiki Activity

Update README.md

Browse source 
Clear Installation Guide
This commit is contained in:
Piping 2018-07-07 08:49:08 -07:00 committed by GitHub
parent 903954985f
commit 8d0397c40f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -38,34 +38,26 @@ Zim has many modules! Enable as many or as few as you'd like.
Installation
------------
Installing Zim is easy. If you have a different shell framework installed (like oh-my-zsh or prezto),
*uninstall those first to prevent conflicts*. It can be installed manually by following the instructions below:
*uninstall those first to prevent conflicts*. Then put following instructions at the end of your .zshrc:
1. In a Zsh shell, clone the repository:
```
git clone --recursive https://github.com/zimfw/zimfw.git ${ZDOTDIR:-${HOME}}/.zim
# Zim initializition
export ZIM_HOME="$HOME/.zsh"
if [ ! -f "$ZIM_HOME/init.zsh" ]; then
echo "Installing zim"
git clone --recursive https://github.com/zimfw/zimfw.git $ZIM_HOME
cat $ZIM_HOME/templates/zlogin >> $HOME/.zlogin
fi
zmodules=(git git-info prompt completion syntax-highlighting autosuggestions fzf-zsh)
zprompt_theme='steeef'
zhighlighters=(main brackets cursor)
source $ZIM_HOME/init.zsh #make sure init after zmodules lists etcs..
```
2. Paste this into your terminal to prepend the initialization templates to your configs:
```
setopt EXTENDED_GLOB
for template_file in ${ZDOTDIR:-${HOME}}/.zim/templates/*; do
user_file="${ZDOTDIR:-${HOME}}/.${template_file:t}"
touch ${user_file}
( print -rn "$(<${template_file})$(<${user_file})" >! ${user_file} ) 2>/dev/null
done
```
3. Set Zsh as the default shell:
```
chsh -s =zsh
```
4. Open a new terminal and finish optimization (this is only needed once, hereafter it will happen upon desktop/tty login):
```
source ${ZDOTDIR:-${HOME}}/.zlogin
```
5. You're done! Enjoy your Zsh IMproved! Take some time to read about the [available modules][modules] and tweak your `.zshrc` file.
You're done! Enjoy your Zsh IMproved! Take some time to read about the [available modules][modules] and tweak your `.zshrc` file.
Updating
--------