docs(readme): update readme about installation methods

pull/7/head
kevin zhuang 4 years ago
parent e0a871e39e
commit a6052af017

@ -49,10 +49,11 @@ with minimal set up required.
## Table of Contents
- [Install](#install)
- [zsh](#zsh)
- [bash](#bash)
- [others](#others)
- [Getting started](#getting-started)
- [Install](#install)
- [Manual](#manual)
- [Zsh Plugin](#zsh-plugin)
- [Dependencies](#dependencies)
- [Setup](#setup)
- [Migration](#migration)
@ -90,56 +91,90 @@ with minimal set up required.
- [Credit](#credit)
- [Demo](#demo)
## Getting started
## Install
### Install
### zsh
#### Manual
dotbare should work with any zsh plugin manager, below is only demonstration
1. Clone the repository (change ~/.dotbare to the location of your preference)
#### zinit
```sh
git clone https://github.com/kazhala/dotbare.git ~/.dotbare
```
```sh
zinit light kazhala/dotbare
```
2. Add dotbare to your PATH (below is only an example, put PATH into your appropriate shellrc file, `$HOME/.zshrc` etc)
#### oh-my-zsh
```sh
# echo "export PATH=$PATH:$HOME/.dotbare" >> "$HOME"/.bashrc
# echo "export PATH=$PATH:$HOME/.dotbare" >> "$HOME"/.zshrc
export PATH=$PATH:$HOME/.dotbare
```
- Clone the repository in to [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh) plugins directory
3. Or you could create a alias which point to dotbare executable
```sh
git clone https://github.com/kazhala/dotbare.git $HOME/.oh-my-zsh/custom/plugins/dotbare
```
```sh
alias dotbare="$HOME/.dotbare/dotbare"
```
- Activate the plugin in `~/.zshrc`
```zsh
plugins=( [plugins...] dotbare [plugins...] )
```
#### Zsh plugin
#### Antigen
##### Zinit
```sh
antigen bundle kazhala/dotbare
```
- Add below to `~/.zshrc`
#### Manual
- Clone the repository (change ~/.dotbare to the location of your preference)
```sh
zinit light kazhala/dotbare
git clone https://github.com/kazhala/dotbare.git ~/.dotbare
```
##### oh-my-zsh
- Put below into `.zshrc`
- Clone the repository in to [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh) plugins directory
```sh
source ~/.dotbare/dotbare.plugin.zsh
```
### bash
- Clone the repository (change ~/.dotbare to the location of your preference)
```sh
git clone https://github.com/kazhala/dotbare.git $HOME/.oh-my-zsh/custom/plugins/dotbare
git clone https://github.com/kazhala/dotbare.git ~/.dotbare
```
- Activate the plugin in `~/.zshrc`
- Put below into `.bashrc` or `.bash_profile`
```zsh
plugins=( [plugins...] dotbare [plugins...] )
```sh
source ~/.dotbare/dotbare.plugin.bash
```
### Others
1. Clone the repository (change ~/.dotbare to the location of your preference)
```sh
git clone https://github.com/kazhala/dotbare.git ~/.dotbare
```
2. Add dotbare to your PATH
```sh
# This is only an example command for Posix shell
# If you are on Fish, use the Fish way to add dotbare to your path
export PATH=$PATH:$HOME/.dotbare
```
3. Or you could create a alias which point to dotbare executable
```sh
alias dotbare="$HOME/.dotbare/dotbare"
```
## Getting started
### Dependencies
- Required dependency

Loading…
Cancel
Save