maj readme
This commit is contained in:
parent
86b33f56a4
commit
c2e5086b1a
55
README.md
55
README.md
|
@ -5,24 +5,24 @@
|
||||||
- [Quick Start](#quick-start)
|
- [Quick Start](#quick-start)
|
||||||
- [Docs](#docs)
|
- [Docs](#docs)
|
||||||
|
|
||||||
## Why
|
## Why VimsCode
|
||||||
|
|
||||||
1. VimsCode, it's beautifull
|
### VimsCode, it's beautifull
|
||||||
|
|
||||||
To write or edit computer code, program an arduino etc... we use IDE (integrated development environment)
|
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.
|
Many very complete graphic software exist to do that like VScode from microsoft or Atom.
|
||||||
|
|
||||||
So why not use them ?
|
So why not use them ?
|
||||||
|
|
||||||
**drawbacks :**
|
**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 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 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)
|
* 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
|
* 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.)
|
* 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 :**
|
||||||
|
|
||||||
|
@ -34,38 +34,37 @@
|
||||||
|
|
||||||
## About
|
## About
|
||||||
|
|
||||||
1. test
|
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
|
![Example-picture](/pictures/image.png)
|
||||||
* Very easy to use
|
|
||||||
* Very easy to install
|
|
||||||
|
|
||||||
![Example-picture](/pictures/image.png)
|
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
1. Introduction:
|
### 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 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
|
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
|
### 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:
|
### Install Plugins :
|
||||||
|
|
||||||
Launch `vim` and run `:PluginInstall`
|
Launch `vim` and run `:PluginInstall`
|
||||||
|
|
||||||
## Docs
|
## Docs
|
||||||
|
|
||||||
1. Short-cute VimsCode
|
### Short-cute VimsCode :
|
||||||
|
|
||||||
```
|
```
|
||||||
"F2" Shows a vim note
|
"F2" Shows a vim note
|
||||||
|
@ -78,6 +77,6 @@
|
||||||
"F9" navigate between vim tabs
|
"F9" navigate between vim tabs
|
||||||
```
|
```
|
||||||
|
|
||||||
2. More Doc
|
### More Doc :
|
||||||
|
|
||||||
https://projets.cohabit.fr/redmine/projects/accueil/wiki/Documentation_IDE_Vim
|
https://projets.cohabit.fr/redmine/projects/accueil/wiki/Documentation_IDE_Vim
|
||||||
|
|
Loading…
Reference in a new issue