VimSence

Getting Started

These instructions will get you a copy of the project up and running on your local machine. More help about the plugin itself can be found here.

Prerequisites

You need to have Vim/NeoVim with Python3 support

Installing

Vim-Plug

1. Add Plug 'vimsence/vimsence' to your vimrc file.
2. Reload your vimrc or restart
3. Run :PlugInstall

Vundle or similar

1. Add Plugin 'vimsence/vimsence' to your vimrc file.
2. Reload your vimrc or restart
3. Run :BundleInstall

NeoBundle

1. Add NeoBundle 'vimsence/vimsence' to your vimrc file.
2. Reload your vimrc or restart
3. Run :NeoUpdate

Dein.vim

1. Add call dein#add('vimsence/vimsence') to your vimrc file.
2. Reload your vimrc or restart
3. Run :call dein#install()

Pathogen

cd ~/.vim/bundle
git clone https://github.com/vimsence/vimsence.git

Vim8 packages

git submodule add https://github.com/vimsence/vimsence.git vimsence

Configuration

You can configure the messages of VimSence in your .vimrc with these options:

let g:vimsence_client_id = '439476230543245312'
let g:vimsence_small_text = 'NeoVim'
let g:vimsence_small_image = 'neovim'
let g:vimsence_editing_details = 'Editing: {}'
let g:vimsence_editing_state = 'Working on: {}'
let g:vimsence_file_explorer_text = 'In NERDTree'
let g:vimsence_file_explorer_details = 'Looking for files'
let g:vimsence_custom_icons = {'filetype': 'iconname'}

Development

First create a virtual environment. If you don’t already have a preferred way to do this, take some time to look at tools like pew, virtualfish, and virtualenvwrapper.

Install the development dependencies:

pip install -r requirements-dev.txt

To avoid committing code that violates our style guide, we strongly advise you to install pre-commit hooks:

pre-commit install

You can also run them anytime using:

pre-commit run --all-files

Authors

Contributor	What has been done
Anne Douwe Bouma	Original work
Hugo Lageneste	Maintaining this fork

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details