Skip to content

Commit

Permalink
fix readme indent
Browse files Browse the repository at this point in the history
  • Loading branch information
haifengkao committed Mar 18, 2020
1 parent 12904e7 commit 6bbd1f5
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,35 +7,35 @@ Installation
------------
Install the python package
::
pip install nfasd
pip install nfasd

Add the following line in your :code:`~/.bashrc`
::
eval "$(register-python-argcomplete-menu nfasd)"
eval "$(register-python-argcomplete-menu nfasd)"

# use TAB to cycle through all possible matches
# optional but highly recommended
[[ $- = *i* ]] && bind TAB:menu-complete
# use TAB to cycle through all possible matches
# optional but highly recommended
[[ $- = *i* ]] && bind TAB:menu-complete

Alternatively, if you use zsh, add the following to :code:`~/.zshrc`
::
eval "$(register-python-argcomplete-menu nfasd)"
# stop shell from beeping for every complete
# optional but highly recommended
setopt NO_LIST_BEEP
eval "$(register-python-argcomplete-menu nfasd)"
# stop shell from beeping for every complete
# optional but highly recommended
setopt NO_LIST_BEEP

For fish shell, you need to install
::
pip install argcomplete
pip install argcomplete

register-python-argcomplete --shell fish my-favourite-script.py > ~/.config/fish/my-favourite-script.py.fish
Configuration
-------------

Add the following to :code:`~/.bashrc` or :code:`~/.zshrc`
::
alias n='nfasd -e nvim'
alias ny='nfasd -e nyaovim'
alias n='nfasd -e nvim'
alias ny='nfasd -e nyaovim'

Then you can press :code:`n myPro<tab>`
to get :code:`n ~/myProject`
Expand All @@ -45,7 +45,7 @@ to get :code:`n ~/myProject`
If you want to exclude certain file patterns,
use the `--exclude` option, e.g.
::
alias n=`nfasd -e nvim --exclude tmp`
alias n=`nfasd -e nvim --exclude tmp`

Changelog
-------------
Expand All @@ -56,7 +56,7 @@ Tips
----
To increase the number of recent files to 1000, add the following line to your `~/.config/nvim/init.vim`
::
set shada=!,'1000,<50,s10,h
set shada=!,'1000,<50,s10,h

Special Thanks
--------------
Expand Down

0 comments on commit 6bbd1f5

Please sign in to comment.