VimsCode/README.md

80 lines
3.3 KiB
Markdown
Raw Normal View History

2023-05-03 13:08:46 +02:00
## Table of Contents
2023-05-03 12:22:24 +02:00
2023-05-03 13:08:46 +02:00
- [About](#about)
- [Quick Start](#quick-start)
- [Docs](#docs)
2023-05-03 12:22:24 +02:00
2023-05-12 15:32:04 +02:00
## About
2023-05-03 12:22:24 +02:00
2023-05-22 10:18:53 +02:00
Pour écrire ou éditer du code informatique, programmer un arduino etc... on utilise des IDE (environnement de développement intégré)
Bien des logiciels graphiques très complets existent pour faire ça comme VScode de microsoft ou Atom.
Modifier cette section
Alors pourquoi pas les utiliser ? Ils ont des inconvénients :
Ils sont gourmands en ressources, beaucoup de RAM (~1,3 Go, soit environ 18 000 fois plus que la mission Apollo 11 qui a envoyé les premiers hommes sur la lune :/ )
* Ils ont assez difficiles à déboguer du fait des grandes couches d'abstraction qui les composent
* Ils ne fonctionnent pas sans système graphique (à travers ssh, sur un serveur ou une Raspberry Pi)
* Il est difficile parfois de leur faire faire une chose simple si elle n'a pas été prévue par ses développeurs
* Ses mises à jour fréquentes imposent parfois des changements dans les habitudes de travail (nouvelles interfaces, nouvelle configuration par défaut, nouveaux chemins etc.)
Alors quelle solution ? Nous vous proposons d'utiliser un des éditeurs de texte historiques en ligne de commande (vi, Vim) pour vous faire votre propre IDE :)
Avantages :
* Léger, ~15Ko soit 4,6 x moins qu'Apollo 11 et 83000 fois moins que VSCODE!!!
* Configurable, on peut tout configurer dans des fichiers textes à partir de configurations déjà très partagées et répendues
* Stabilité, il ne fait qu'évoluer sans rompre la continuité ergonomique (toujours les mêmes commandes et raccourcis depuis 1991 pour vim et 1976 pour vi :) de même pour les configurations qui restent valides depuis le début...)
* Utilisable à travers SSH sur des serveurs ou des ordis très légers (Raspberry Pi, etc.)
* Rock solid, les plantages doivent exister, mais je n'en ai jamais même entendu parler
Ici, nous vous donnons un exemple de configuration de votre IDE Vim pour Debian.
Si vous ne connaissez pas Vim, vous pouvez commencer par là https://www.youtube.com/watch?v=m4WFcLX7Xc8
2023-05-12 15:32:04 +02:00
VimsCode is an IDE with vim for beginner or expert
2023-05-03 12:22:24 +02:00
2023-05-12 15:32:04 +02:00
* VimsCode use arduino-cli, idf-esp and platform.io-cli for remplace VScode only in terminal
2023-05-03 13:08:46 +02:00
* Very easy to use
* Very easy to install
2023-05-12 15:32:04 +02:00
![Example-picture](/pictures/image.png)
2023-05-03 12:22:24 +02:00
2023-05-12 15:32:04 +02:00
## Quick Start
2023-05-03 13:08:46 +02:00
1. Introduction:
2023-05-12 15:40:22 +02:00
Installation requires [git, wget, flex, bison, gperf, python3, python3-venv, cmake, ninja-build, ccache, libffi-dev, libssl-dev, dfu-util, libusb-1.0-0]
2023-05-12 16:03:40 +02:00
```
sudo apt update
2023-05-15 12:54:37 +02:00
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
2023-05-12 16:03:40 +02:00
```
2023-05-03 13:08:46 +02:00
2. Set up VimsCode
2023-05-09 11:27:38 +02:00
git clone https://git.cohabit.fr/bastien/VimsCode.git
2023-05-09 16:33:31 +02:00
2023-05-09 16:32:48 +02:00
After clone don't forgot to rename "vimrc-conf" -> ".vimrc" and "/vim-conf" -> "/vim"
2023-05-03 13:08:46 +02:00
2023-05-09 11:27:38 +02:00
3. Install Plugins:
2023-05-03 13:08:46 +02:00
Launch `vim` and run `:PluginInstall`
2023-05-12 15:32:04 +02:00
## Docs
2023-05-03 13:08:46 +02:00
2023-05-15 12:45:03 +02:00
1. Short-cute VimsCode
2023-05-15 12:54:37 +02:00
```
2023-05-15 12:47:56 +02:00
"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
2023-05-15 12:54:37 +02:00
```
2023-05-15 12:45:03 +02:00
2. More Doc
2023-05-03 13:08:46 +02:00
https://projets.cohabit.fr/redmine/projects/accueil/wiki/Documentation_IDE_Vim