AstroJS/README.md

VimArea is a lightweight functional vim using the *screen buffer* approach. What I am trying to do is to achieve that smooth-vim-feeling as close as possible to the original Vim in a general terminal.

## Downloads
Please head to the release section of this repo.

## Dependency
All downloadable versions are standalone. For development, see [contribution](/#user-content-how-can-i-contribute)

## Demo
Visit the demo over [here](https://tgckpg.github.io/VimArea)

## As of version 1.0.x
Common commands are now supported. I am now going to list the commands that is yet to be made.
```
Commands that are going to implement soon:
auto indent ( new line from bracket )
:'<,'>

Commands that are planning to implement in near future:
macro
code auto format "="
:set nowrap

Commands that are planning to implement in far future:
Split screen - this is possible by design

Commands that are impossible to implement:
VISUAL BLOCK - Multiple highlighting in textarea is not possible
Syntax highlighting - individual styles cannot be applied into a textarea
plugins - I am NOT going to make this
```

### How does it work
By *screen buffer*, it means that the textarea is treated as a screen. You are not directly interacting with the textarea. Instead you type into the script, then the result is *rendered* through the textarea.

### Why use a screen buffer
By treating the textarea as a *screen*. I could archive almost everything except for coloring. Plus it is easier to precisely track the cursor in this way.

Visit this [blog entry](https://blog.astropenguin.net/article/view/vimarea-day-1-hjkl/) for details.

### How the source code works
This is based on a framework I wrote called BotanJS. Which is a frontend framework & Service API that is so big that I am too busy ( lazy ) to explain. If you are only interested in the Vim itself only. It is recommended to download the compiled source code provided in the demo site above.

If you are also interested in [BotanJS](https://github.com/tgckpg/BotanJS). Please head to the project page [here](https://github.com/tgckpg/BotanJS). *Warning*, it might NOT be easy to understand. ( but it should be easy to setup )

### Why make another one?
Because ( at the time of this repository created ) the addon [wasavi](https://github.com/akahuku/wasavi) in firefox does not work. I know people are busy so fuck me I am going to make one myself, alright?

### Use wasavi if you can
#### [wasavi! wasavi! wasavi!](https://github.com/akahuku/wasavi)
[wasavi](https://github.com/akahuku/wasavi) is so good! This is a must-have plugin in Google Chrome. If you haven't heard of that yet seriously go use it now!

I tried porting it into the browser tho. But I am too stupid to do that. But still I highly recommend using it.

### How can I contribute?
First, you need to understand the framework behind it ( see "How the source code works" above ). Setup the environment and you are ready to go! Feel free to ask by opening an issue :)