96 lines
3 KiB
Markdown
96 lines
3 KiB
Markdown
## Table of Contents
|
|
|
|
- [Why](#Why)
|
|
- [About](#about)
|
|
- [Quick Start](#quick-start)
|
|
- [Docs](#docs)
|
|
|
|
## Why VimsCode
|
|
|
|
### VimsCode, it's beautiful
|
|
|
|
To write or edit computer code, program an arduino etc... we use IDE (integrated development environment)
|
|
Many very complete graphic software exist to do that like VScode from microsoft or Atom.
|
|
|
|
So why not use them ?
|
|
|
|
**drawbacks :**
|
|
|
|
* They are resource intensive, lots of RAM (~1.3 GB, about 18,000 times more than the Apollo 11 mission that sent the first men to the moon :/ )
|
|
* They are quite difficult to debug because of the large abstraction layers that make them up
|
|
* They don't work without a graphical system (through ssh, on a server or a Raspberry Pi)
|
|
* It is sometimes difficult to make them do something simple if it was not planned by the developers
|
|
* Its frequent updates sometimes impose changes in working habits (new interfaces, new default configuration, new paths etc.)
|
|
|
|
So which solution? We suggest you use one of the historical command line text editors (vi, Vim) to make your own IDE :)
|
|
|
|
**Advantages :**
|
|
|
|
* Lightweight, ~15Kb which is 4.6 x less than Apollo 11 and 83000 times less than VSCODE!!!
|
|
* Configurable, you can configure everything in text files from already shared and popular configurations
|
|
* Stable, it only evolves without breaking the ergonomic continuity (always the same commands and shortcuts since 1991 for vim and 1976 for vi :) same for the configurations which remain valid since the beginning...)
|
|
* Usable through SSH on servers or very light computers (Raspberry Pi, etc.)
|
|
* Rock solid, crashes must exist, but I've never even heard of them
|
|
|
|
## About
|
|
|
|
VimsCode is an IDE with vim for beginner or expert :
|
|
|
|
* VimsCode use arduino-cli, idf-esp and platform.io-cli for remplace VScode only in terminal
|
|
* Very easy to use
|
|
* Very easy to install
|
|
|
|
|
|
|
|
## Quick Start
|
|
|
|
### Introduction :
|
|
|
|
Installation requires [git; wget; flex; bison; gperf; python3; python3-venv; cmake; ninja-build; ccache; libffi-dev; libssl-dev; dfu-util; libusb-1.0-0]
|
|
|
|
```
|
|
sudo apt update
|
|
sudo apt install git; wget; flex; bison; gperf; python3; python3-venv; cmake; ninja-build; ccache; libffi-dev; libssl-dev; dfu-util; libusb-1.0-0; elinks
|
|
```
|
|
### Set up VimsCode :
|
|
|
|
git clone https://git.cohabit.fr/bastien/VimsCode.git
|
|
|
|
After clone don't forgot to rename "vimrc-conf" -> ".vimrc" and "/vim-conf" -> "/vim"
|
|
|
|
```
|
|
cd vimscode
|
|
mv vim-conf .vim && mv .vim ~/
|
|
mv vimrc-conf .vimrc && mv .vimrc ~/
|
|
```
|
|
|
|
### Alias
|
|
|
|
Edit your bashrc or zshrc with this ligne :
|
|
```
|
|
alias vimscode="~/.vim/vimscode.sh"
|
|
```
|
|
|
|
### Install Plugins :
|
|
|
|
Launch `vim` and run `:PluginInstall`
|
|
|
|
## Docs
|
|
|
|
### Short-cute VimsCode :
|
|
|
|
```
|
|
"F2" Shows a vim note
|
|
"F3" Shows the tree structure
|
|
"F4" Shows the history of changes made
|
|
"F5" Shows a terminal at the bottom
|
|
"F6" Allows scrolling in the terminal
|
|
"F7" Brings up a help site for vim and terminal
|
|
"F8" created a new vim tab
|
|
"F9" navigate between vim tabs
|
|
```
|
|
|
|
### More Doc :
|
|
|
|
https://projets.cohabit.fr/redmine/projects/accueil/wiki/Documentation_IDE_Vim
|