Skip to content

Commit

Permalink
Merge pull request #80 from ok97465/update_readme
Browse files Browse the repository at this point in the history
PR: Update readme.md
  • Loading branch information
dalthviz committed Oct 3, 2022
2 parents ae46fba + 3cc4022 commit fefde6b
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 28 deletions.
75 changes: 47 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,82 +1,101 @@
# spyder-vim
Spyder Plugin for executing Vim commands inside the code editor. We currently support the following keybindings and commands: https://github.com/spyder-ide/spyder-vim/issues/1

## Project Info

[![Project License](https://img.shields.io/pypi/l/spyder-vim.svg)](./LICENSE.txt)
[![pypi version](https://img.shields.io/pypi/v/spyder-vim.svg)](https://pypi.python.org/pypi/spyder-vim)
[![Join the chat at https://gitter.im/spyder-ide/public](https://badges.gitter.im/spyder-ide/spyder.svg)](https://gitter.im/spyder-ide/public)
[![OpenCollective Backers](https://opencollective.com/spyder/backers/badge.svg?color=blue)](#backers)
[![OpenCollective Sponsors](https://opencollective.com/spyder/sponsors/badge.svg?color=blue)](#sponsors)

## Build status

![Linux tests](https://github.com/spyder-ide/spyder-vim/workflows/Linux%20tests/badge.svg)
![Macos tests](https://github.com/spyder-ide/spyder-vim/workflows/Macos%20tests/badge.svg)
![Window tests](https://github.com/spyder-ide/spyder-vim/workflows/Windows%20tests/badge.svg)
[![Coverage Status](https://coveralls.io/repos/github/spyder-ide/spyder-vim/badge.svg?branch=master)](https://coveralls.io/github/spyder-ide/spyder-vim?branch=master)

----

## Important Announcement: Spyder is unfunded!

Since mid November/2017, [Anaconda, Inc](https://www.anaconda.com/) has
stopped funding Spyder development, after doing it for the past 18
months. Because of that, development will focus from now on maintaining
Spyder 3 at a much slower pace than before.

If you want to contribute to maintain Spyder, please consider donating at

https://opencollective.com/spyder
# Overview

We appreciate all the help you can provide us and can't thank you enough for
supporting the work of Spyder devs and Spyder development.
Spyder Plugin for executing Vim commands inside the code editor. Although it does not currently support many VIM commands, it will be developed gradually.

If you want to know more about this, please read this
[page](https://github.com/spyder-ide/spyder/wiki/Anaconda-stopped-funding-Spyder).
<img src="/doc/example.gif" width="600">

----
| Category | supported commands |
| ------------ | ----------------------------------------------------------------------------- |
| Movement | h, j, k, l, w, b, e, space, backspace, return, $, 0, ^, G, gg, zz, H, L, M, % |
| Change | x, r, o, O, u, d, dd, dw, D, c, cc, cw, J, ~, <, >, <<, >> |
| Copy & Paste | yy, yw, y$, p, P |
| Search | /, ?, n, N, f, F |
| mode | i, I, a, A, v, V |
| Register | -, 0, 1, unamed |
| File | ZZ, gt, gT, :w, :q, :wq, :n, :e |

## Installation

To install this plugin, you can use either ``pip`` or ``conda`` package managers, as it follows:

Using pip:

```
pip install spyder-vim
```

Using conda:

```
conda install spyder-vim -c spyder-ide
conda install spyder-vim -c conda-forge
```

## Dependencies

This project depends on [Spyder](https://github.com/spyder-ide/spyder).

## Changelog

Visit our [CHANGELOG](CHANGELOG.md) file to know more about our new features and improvements.

## Development and contribution

Do you want to request a new keybind for the plugin? Please submit it to our [Commands](https://github.com/spyder-ide/spyder-vim/issues/1) issue page. Feel free to open a PR to implement it.

To start contributing to this project, you can execute ``pip install -U .`` to test your changes on Spyder. We follow PEP8 and PEP257 style guidelines.
To start contributing to the source code of this project, please check our [contributing guide](https://github.com/spyder-ide/spyder-vim/blob/master/CONTRIBUTING.md) to setup a development environment and be able to test your changes on Spyder. We follow PEP8 and PEP257 style guidelines.

# Overview
![alt tag](/doc/example.gif)
Everyone is welcome to contribute!

## Sponsors

## Contributing
Spyder is funded thanks to the generous support of

Everyone is welcome to contribute!
[![Quansight](https://user-images.githubusercontent.com/16781833/142477716-53152d43-99a0-470c-a70b-c04bbfa97dd4.png)](https://www.quansight.com/)[![Numfocus](https://i2.wp.com/numfocus.org/wp-content/uploads/2017/07/NumFocus_LRG.png?fit=320%2C148&ssl=1)](https://numfocus.org/)

and the donations we have received from our users around the world through [Open Collective](https://opencollective.com/spyder/):

## Backers
[![Sponsors](https://opencollective.com/spyder/sponsors.svg)](https://opencollective.com/spyder#support)

Support us with a monthly donation and help us continue our activities.
## More information

[![Backers](https://opencollective.com/spyder/backers.svg)](https://opencollective.com/spyder#support)
[Main Website](https://www.spyder-ide.org/)

[Download Spyder (with Anaconda)](https://www.anaconda.com/download/)

## Sponsors
[Online Documentation](https://docs.spyder-ide.org/)

Become a sponsor to get your logo on our README on Github.
[Spyder Github](https://github.com/spyder-ide/spyder)

[![Sponsors](https://opencollective.com/spyder/sponsors.svg)](https://opencollective.com/spyder#support)
[Troubleshooting Guide and FAQ](
https://github.com/spyder-ide/spyder/wiki/Troubleshooting-Guide-and-FAQ)

[Development Wiki](https://github.com/spyder-ide/spyder/wiki/Dev:-Index)

[Gitter Chatroom](https://gitter.im/spyder-ide/public)

[Google Group](https://groups.google.com/group/spyderlib)

[@Spyder_IDE on Twitter](https://twitter.com/spyder_ide)

[@SpyderIDE on Facebook](https://www.facebook.com/SpyderIDE/)

[Support Spyder on OpenCollective](https://opencollective.com/spyder/)
Binary file modified doc/example.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fefde6b

Please sign in to comment.