AstroJS/README.md

52 lines
2.6 KiB
Markdown
Raw Normal View History

2016-03-14 22:12:31 +00:00
# BotanJS-vim
2016-03-21 18:55:29 +00:00
This is a 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.
2016-03-14 22:12:31 +00:00
2016-04-04 23:52:25 +00:00
## Demo
2016-04-28 04:38:38 +00:00
Visit the demo over [here](https://tgckpg.github.io/VimArea)
2016-03-21 18:55:29 +00:00
2016-04-04 23:52:25 +00:00
## This is going to be release soon
Common commands are now supported. I am now going to list the commands that yet to be made.
2016-03-21 18:55:29 +00:00
```
2016-04-04 23:52:25 +00:00
Commands that are going to implement soon:
2016-04-15 20:05:47 +00:00
auto indent ( new line from bracket ), [action]i[quote]
2016-04-04 23:52:25 +00:00
:'<,'>
Commands that are planning to implement in near future:
macro
2016-04-15 20:05:47 +00:00
code auto format "="
2016-04-04 23:52:25 +00:00
: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
2016-03-21 18:55:29 +00:00
```
### How it works
2016-04-15 20:05:47 +00:00
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.
2016-03-21 18:55:29 +00:00
### Why use screen buffer?
By treating the textarea as a *screen*. I could archive almost everything except for coloring. And it is easier to precisely track the cursor this way.
2016-04-04 23:52:25 +00:00
Visit this [blog](https://blog.astropenguin.net/article/view/vimarea-day-1-hjkl/) entry for details.
2016-03-21 18:55:29 +00:00
### 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.
2016-04-02 12:08:04 +00:00
### Why make another one?
Because [wasavi](https://github.com/akahuku/wasavi) in firefox does not work for me. I know peoples are busy so fuck me I am going to make one myself, alright?
2016-03-21 18:55:29 +00:00
### 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. Then file a merge request. Sounds easy right?... prepare to DIEEE!