diff --git a/README.md b/README.md index c464a18..524c25d 100644 --- a/README.md +++ b/README.md @@ -6,58 +6,58 @@ ## About -### 1. Why change +#### 1. Why change - 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. +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 ? They have drawbacks: +So why not use them ? They have 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.) +* 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 :) +So which solution? We suggest you use one of the historical command line text editors (vi, Vim) to make your own IDE :) - Advantages : +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 +* 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 #### 2. Avantages of this solution - VimsCode is an IDE with vim for beginner or expert +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 - * VimsCode use arduino-cli, idf-esp and platform.io-cli for remplace VScode only in terminal - * Very easy to use - * Very easy to install - ![Example-picture](/pictures/image.png) ## Quick Start #### 1. 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] +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 ``` #### 2. Set up VimsCode - git clone https://git.cohabit.fr/bastien/VimsCode.git +git clone https://git.cohabit.fr/bastien/VimsCode.git - After clone don't forgot to rename "vimrc-conf" -> ".vimrc" and "/vim-conf" -> "/vim" +After clone don't forgot to rename "vimrc-conf" -> ".vimrc" and "/vim-conf" -> "/vim" #### 3. Install Plugins: - Launch `vim` and run `:PluginInstall` +Launch `vim` and run `:PluginInstall` ## Docs