bastien/VimsCode
1
2
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

ajustement par rapport a l'update

Browse source
This commit is contained in:
bastien 2023-07-11 16:43:17 +02:00
parent f6468d6dd5
commit ee14f6a205
10 changed files with 579 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -57,12 +57,11 @@ sudo apt install git elinks
### Set up VimsCode : ### Set up VimsCode :
After clone don't forgot to rename "vimrc-conf" -> ".vimrc" and "/vim-conf" -> "/vim" : After clone don't forgot to rename "vimrc-conf" -> ".vimrc" :
``` ```
git clone https://git.cohabit.fr/bastien/VimsCode.git git clone https://git.cohabit.fr/bastien/VimsCode.git
cd vimscode mv ../vimscode ~/.vim
mv vim-conf .vim && mv .vim ~/
mv vimrc-conf .vimrc && mv .vimrc ~/ mv vimrc-conf .vimrc && mv .vimrc ~/
cd ~/.vim/bundle/ && git clone https://github.com/VundleVim/Vundle.vim.git cd ~/.vim/bundle/ && git clone https://github.com/VundleVim/Vundle.vim.git
``` ```

0
bundle/.gitkeep Normal file
View file

119
help/En/help-arduino Normal file
View file

@ -0,0 +1,119 @@
Short-cute VimsCode :
<F2> launch a vim note
<F3> launch the folder tree where you are
<F4> launch the change history
<F5> launch a terminal at the bottom
<F6> scroll through terminal
<F7> launch a help site for vim and terminal
<F8> created a new vim tab
<F9> navigates between vim tabs
Help for arduino:
arduino-cli board # Displays the arduino controls
attach # Attach a project to a map
details # Displays details on the map
list # Lists the connected cards
listall # Lists all known maps and their FQBN correspondence
search # Search the map in the map getionaires
arduino-cli burn-bootloader # Downloads the bootloader
arduino-cli cache clean # Clear cache
arduino-cli compile # Compiles the program on the board
arduino-cli config # Allows to have the arduino configuration controls
add # Adds another value to a setting
delete # Deletes a parameter and these sub-parameters
dump # Displays current settings
init # Creates a project
remove # Removes one or more values from a parameter
set # Sets a value to a parameter
arduino-cli core # Allows operations on the arduino heart
download # Download one or more hearts and all dependent tools
install # Installs one or more cores and all dependent tools
list # Displays the list of installed platforms
search # Look for a heart in the card manager
uninstall # Uninstall one or more cores and all dependent tools
update-index # Updates the heart index
upgrade # Updates one or more platforms
arduino-cli debug # Allows debug
arduino-cli help # Displays arduino help
arduino-cli lib # Allows to display the list of apropos library commands
deps # Looks at the status of a dependency for a specific library
download # Download one or more libraries without installing it
examples # Displays library examples
install # Install one or more libraries in the system
list # Displays installed libraries
search # Search for one or more library data
uninstall # Uninstall one or more libraries
update-index # Updates the library index
upgrade # Updates all installed libraries
arduino-cli monitor # Opens a communication port with card
arduino-cli monitor -p /dev/ttyaCM0 --describe # Example
--board-options strings # Lists options
--config strings or -c # Configure a port
--describe # Displays all communication port settings
--discovery-timeout "duration" # Lets you choose the time to discover a port
--fqbn string or -b # Change the card name
--help or -h # Display help
--port string or -p # Change port address
--protocol string or -l # Change protocol
--quiet or -q # Displays only input and output monitor
arduino-cli outdated # Lists hearts and libraries that can be updated
arduino-cli sketch # Create/archive an arduino project
archive # Create a project archive
new # Create a new project
arduino-cli update # Updates the index of hearts and libraries
arduino-cli upgrade # Updates installed cores and libraries
arduino-cli upload # Download an arduino project
arduino-cli version # Displays the arduino-cli version
Valid additional arguments for all commands above:
--config-file string # Allows you to choose a custom configuration file
--format string # Lets you choose the format to output logs
--log-file string # Lets you choose where the logs are stored
--verbose or -v # Provides more information
Example of simple use:
# To connect new indexes download
arduino-cli core update-index
# To list all connected boards
arduino-cli board list
# To install a core, an example with samd but you can do it with avr (to know how to look at the FQBN of the card)
arduino-cli core install arduino:samd
# To see the installed cores
arduino-cli core list
# To compile
arduino-cli compile --fqbn "FQBN of the card" "file name"
arduino-cli compile --fqbn arduino:samd:mkr1000 MyFirstSketch # Example
# To upload
arduino-cli upload -p/dev/ttyACM0 --fqbn "FQBN of the card" "file name"
ttyUSB0

59
help/En/help-esp32 Normal file
View file

@ -0,0 +1,59 @@
Short-cute VimsCode :
<F2> launch a vim note
<F3> launch the folder tree where you are
<F4> launch the change history
<F5> launch a terminal at the bottom
<F6> scroll through terminal
<F7> launch a help site for vim and terminal
<F8> created a new vim tab
<F9> navigates between vim tabs
Help for ESP32 :
add-dependency # Add dependency to the manifest file.
all # Aliases: build. Build the project.
app # Build only the app.
app-flash # Flash the app only.
bootloader # Build only bootloader.
bootloader-flash # Flash bootloader only.
build-system-targets # Print list of build system targets.
clean # Delete build output files from the build directory.
compote component delete # Delete specified version of the component from the component registry.
compote component upload # Upload component to the component registry.
compote component upload-status # Check the component uploading status by the job ID.
confserver # Run JSON configuration server.
coredump-debug # Create core dump ELF file and run GDB debug session with file.
coredump-info # Print crashed task’s registers.
create-component # Create a new component.
create-manifest # Create manifest for specified component.
create-project # Create a new project.
create-project-from-example # Create a project from an example.
docs # Open web browser with documentation for ESP-IDF.
efuse-common-table # Generate C-source for IDF's eFuse fields.
efuse-custom-table # Generate C-source for user's eFuse fields.
encrypted-app-flash # Flash the encrypted app only.
encrypted-flash # Flash the encrypted project.
erase-flash # Erase entire flash chip.
erase-otadata # Erase otadata partition.
flash # Flash the project.
fullclean # Delete the entire build directory contents.
gdb # Run the GDB.
gdbgui # GDB UI in default browser.
gdbtui # GDB TUI mode.
menuconfig # Run "menuconfig" project configuration tool.
monitor # Display serial output.
openocd # Run openocd from current path.
partition-table # Build only partition table.
partition-table-flash # Flash partition table only.
post-debug # Utility target to read the output of async debug action and stop them.
python-clean # Delete generated Python byte code from the IDF directory.
read-otadata # Read otadata partition.
reconfigure # Re-run CMake.
save-defconfig # Generate a sdkconfig.defaults with options different from the default ones.
set-target # Set the chip target to build.
show-efuse-table # Print eFuse table.
size # Print basic size information about the app.
size-components # Print per-component size information.
size-files # Print per-source-file size information.
uf2 # Generate the UF2 binary with all the binaries included.
uf2-app # Generate an UF2 binary for the application only.

97
help/En/help-platform.io Normal file
View file

@ -0,0 +1,97 @@
Short-cute VimsCode :
<F2> launch a vim note
<F3> launch the folder tree where you are
<F4> launch the change history
<F5> launch a terminal at the bottom
<F6> scroll through terminal
<F7> launch a help site for vim and terminal
<F8> created a new vim tab
<F9> navigates between vim tabs
Help for Platform.io cli :
pio access
grant # Add the ability of users and teams to have “LEVEL” access to a resource.
list # Show all of the resources (packages) a user or a team can access, along with the access level.
private # Set a resource to be either privately accessible (restricted access to particular users or team members).
public # Set a resource to be either publicly accessible.
revoke # Remove the ability of users and teams to have access to a resource.
pio boards # List pre-configured Embedded Boards.
pio check # Perform static analysis check on PlatformIO based project.
pio debug # Prepare PlatformIO project for debugging or launch debug server.
pio device
list # List available devices.
monitor # This is a console application that provides a small terminal application.
pio home # Launch PlatformIO Home Web-server.
pio org
add # Add a user as an owner to an organization.
create # Create a new organization.
destroy # Destroy an organization and its teams.
list # List organizations and their owners.
remove # Remove a user from an organization.
update # Rename the organization or update the existing details.
pio pkg
exec # Run command from a PlatformIO package.
install # Install the project dependencies or custom packages from the PlatformIO Registry or external sources.
list # Print to stdout installed packages and their dependencies in a tree structure based on project dependencies declared in “platformio.ini”
outdated # Check for outdated project packages and list version information for all dependencies.
pack # Create a tarball from a package.
publich # Publish a package to the PlatformIO Registry so that it can be installed by name.
search # Search the PlatformIO Registry for packages matching the search query.
show # Show package information from the PlatformIO Registry.
uninstall # Uninstall the project dependencies or custom packages from the PlatformIO Registry or external sources.
unpublish # This removes a package version from the registry, deleting its entry and removing the tarball.
update # Update the project dependencies, custom packages from the PlatformIO Registry, or external sources.
pio platform
frameworks # List supported Frameworks (SDKs, etc).
install # Install Development Platforms and dependent packages.
list # List installed Development Platforms.
search # Search for development Development Platforms.
show # Show details about Development Platforms.
uninstall # Uninstall specified Development Platforms.
update # Check or update installed Development Platforms.
pio project
config # Show project computed configuration based on “platformio.ini”.
init # Initialize a new PlatformIO based project or update existing with new data.
metadata # Dump a build metadata intended for IDE extensions/plugins.
pio remote
device list # List Serial Ports on remote machines where PlatformIO Remote Agent is started.
device monitor # Connect to Serial Port of remote device and receive or send data in real time.
run # Process environments which are defined in “platformio.ini” (Project Configuration File) file remotely.
agent list # List active PlatformIO Remote Agent s started using own PlatformIO Account.
agent start # Start PlatformIO Remote Agent and work remotely with your devices from anywhere in the world.
test # Run remotely tests from PlatformIO based project.
update # Check or update installed Development Platforms and global Libraries on the remote machine.
pio run # Run project targets over environments declared in “platformio.ini” (Project Configuration File).
pio settings
get # Get/List existing settings.
set # Set new value for the setting.
reset # Reset settings to default.
pio system
completion install # Install tab completion support for: bash, zsh, fish.
completion uninstall # Uninstall shell completion files or code for: bash, zsh, fish.
info # Display PlatformIO system-wide information.
prune # Remove unused data
pio test # Run project tests on host (local) machine using PlatformIO Unit Testing.
pio update # Check or upgrade PlatformIO Core to the latest version.
pio upgrade # Check or update installed PlatformIO Core packages, Development Platforms and global Libraries.
For more information on the above orders: https://docs.platformio.org/en/latest/core/userguide/index.html#commands

120
help/Fr/aide-arduino Normal file
View file

@ -0,0 +1,120 @@
Raccourcis VimsCode :
<F2> invoque une note vim
<F3> invoque l'arborescence du dossier ou vous vous trouvez
<F4> invoque l'historique des modifications effectué
<F5> invoque un terminal en bas
<F6> permet de scroll dans le terminal
<F7> invoque un site d'aide pour vim et terminal
<F8> créé un nouvel onglet vim
<F9> navigue entre les onglets vim
Aide pour arduino :
arduino-cli board # Affiche les commandes de la arduino
attach # Attache un projet à une carte
details # Affiche des détails sur la carte
list # Listes les cartes connectés
listall # Listes toutes les cartes connus et leur correspondance FQBN
search # Cherche dans la carte dans le getionnaires de carte
arduino-cli burn-bootloader # Télécharge le bootloader
arduino-cli cache clean # Efface le cache
arduino-cli compile # Permet de compiler le programme sur la carte
arduino-cli config # Permet d'avoir les commandes de configurations arduino
add # Ajoute une autre valeur à un réglage
delete # Supprime un paramètre et ces sous paramètres
dump # Affiche les paramètres actuels
init # Crée un projet
remove # Supprime une ou plusieurs valeurs d'un paramètres
set # Définit une valeur à un paramètre
arduino-cli core # Permet de faire une opérations sur le coeur arduino
download # Télécharge un ou plusieurs coeurs et touts les outils dépendants
install # Installe un ou plusieurs coeurs et touts les outils dépendants
list # Affiche la liste des platformes installés
search # Cherche un coeur dans la gestionnaire de carte
uninstall # Désinstalle un ou plusieurs coeurs et touts les outils dépendants
update-index # Met à jour l'index des coeurs
upgrade # Met à jour un ou plusieurs platformes
arduino-cli debug # Permet de debug
arduino-cli help # Affiche l'aide arduino
arduino-cli lib # Permet d'afficher la liste des commandes apropos des librairies
deps # Regarde le status d'une dépendance pour une librairies spécifique
download # Télécharge une ou plusieurs librairies sans l'installer
examples # Affiche les exemples de librairies
install # Installe une ou plusieurs librairies dans le système
list # Affiche les librairies installés
search # Recherche une ou plusieurs données de librairies
uninstall # Désinstalle une ou plusieurs librairies
update-index # Met à jour l'index des librairies
upgrade # Met à jour toutes les librairies installés
arduino-cli monitor # Permet d'ouvrir un port de communication avec carte
arduino-cli monitor -p /dev/ttyaCM0 --describe # Exemple
--board-options strings # Listes les options
--config strings ou -c # Configure un port
--describe # Affiche tous les paramètres du port de communication
--discovery-timeout "durée" # Permet de choisir le temps pour découvrir un port
--fqbn string ou -b # Permet de changer le nom de la carte
--help ou -h # Invoque l'aide
--port string ou -p # Permet de changer l'adresse du port
--protocol string ou -l # Permet de changer le protocol
--quiet ou -q # Affiche seulement le moniteur d'entré et de sortie
arduino-cli outdated # Liste les coeurs et librairies qui peuvent être mis à jour
arduino-cli sketch # Permet de créer/archiver un projet arduino
archive # Créer une archive du projet
new # Créer un nouveau projet
arduino-cli update # Met à jour l'index des coeurs et librairies
arduino-cli upgrade # Met à jour les coeurs et librairies installés
arduino-cli upload # Télécharge un projet arduino
arduino-cli version # Affiche la version de arduino-cli
arguments supplémentaires valide pour toutes les commandes ci-dessus :
--config-file string # Permet de choisir un fichier de configuration personnalisé
--format string # Permet de choisir le format de sortir des logs
--log-file string # Permet de choisir à quel endroit les logs sont stockés
--verbose ou -v # Permet de donner plus d'informations
Exemple d'utilisatio simple :
# Pour connecter des nouveaux index télécharger
arduino-cli core update-index
# Pour lister toutes les cartes connectées
arduino-cli board list
# Pour installer un coeur, un exemple avec samd mais on peut le faire avec avr (pour savoir regarder le FQBN de la carte)
arduino-cli core install arduino:samd
# Pour voir les coeurs installés
arduino-cli core list
# Pour compiler
arduino-cli compile --fqbn "FQBN de la carte" "nom du fichier"
arduino-cli compile --fqbn arduino:samd:mkr1000 MyFirstSketch # Exemple
# Pour téléverser
arduino-cli upload -p /dev/ttyACM0 --fqbn "FQBN de la carte" "nom du fichier"
ttyUSB0

60
help/Fr/aide-esp32 Normal file
View file

@ -0,0 +1,60 @@
Raccourcis VimsCode :
<F2> Invoque une note vim
<F3> Invoque l'arborescence du dossier ou vous vous trouvez
<F4> Invoque l'historique des modifications effectué
<F5> Invoque un terminal en bas
<F6> Permet de scroll dans le terminal
<F7> Invoque un site d'aide pour vim et terminal
<F8> Créer un nouvel onglet vim
<F9> Navigue entre les onglets vim
Aide pour ESP32 :
add-dependency # Ajout de dépendance.
all # Alias de build, construit le projet.
app # Construit uniquement l'app.
app-flash # Flash uniquement l'app.
bootloader # Construit uniquement le bootloader.
bootloader-flash # Flash uniquement le bootloader.
build-system-targets # Affiche la liste des cibles systèmes.
clean # Supprime les fichiers de sortie de la compilation.
compote component delete # Supprime la version spécifié du composant du registre des composants.
compote component upload # Télécharge un composant dans le registre de composant.
compote component upload-status # Vérifie les composants de l'état du téléchargement par l'ID du travail.
confserver # Exécute la configuration JSON du serveur.
coredump-debug # Créer le fichier ELF de vidage du noyau et éxecute la session de débogage GDB avec ce fichier.
coredump-info # Affiche le registre des erreurs.
create-component # Créer un nouveau composant.
create-manifest # Créer un manifeste pour spécifié les composants.
create-project # Créer un nouveau projet.
create-project-from-example # Créer un nouveau projet exemple.
docs # Ouvre un navigateur avec la documentation.
efuse-common-table # Génére un c-source pour le champ de l'idf efuse.
efuse-custom-table # Génére un c-source pour le champ de l'utilisateur efuse.
encrypted-app-flash # Flash uniquement l'app chiffré.
encrypted-flash # Flash uniquement le projet chiffré.
erase-flash # Ecrase toute la puce flash.
erase-otadata # Ecrase les données totales de la partition.
flash # Flash le projet.
fullclean # Supprime l'intégralité du contenu du dossier de construction.
gdb # Exécute GDB.
gdbgui # Interface utilisateur GDB dans le navigateur par defaut.
gdbtui # Mode TUI GDB.
menuconfig # Exécute le "menuconfig" de la configuration d'outil du projet.
monitor # Affiche la sortie sérial.
openocd # Exécute openocd depuis le chemin courant.
partition-table # Construit uniquement une table de partition.
partition-table-flash # Flash uniquement la table de partition.
post-debug # Cible l'utilitaire pour lire la sortie de l'action de débogage asynchrone et les arrêter.
python-clean # Supprime le code d'octet python généré du dossier IDF.
read-otadata # Lire les données totales de la partition.
reconfigure # Ré-exécute CMake
save-defconfig # Génére sdkconfig.defaults avec une option différente par defaut.
set-target # Cible l'ensemble de la construction de la carte.
show-efuse-table # Affiche la table efuse.
size # Affiche les informations de taille de base apropos de l'app.
size-components # Affiche les informations de tailles par composant.
size-files # Affiche les informations de tailles par fichier source.
uf2 # Génére le binaire UF2 avec tous les binaires inclus.
uf2-app # Génére le binaire UF2 pour l'app uniquement.

87
help/Fr/aide-platform.io Normal file
View file

@ -0,0 +1,87 @@
Raccourcis VimsCode :
<F2> Invoque une note vim
<F3> Invoque l'arborescence du dossier ou vous vous trouvez
<F4> Invoque l'historique des modifications effectué
<F5> Invoque un terminal en bas
<F6> Permet de scroll dans le terminal
<F7> Invoque un site d'aide pour vim et terminal
<F8> Créer un nouvel onglet vim
<F9> Navigue entre les onglets vim
Aide pour Platfor.io cli :
pio access
pio access grant # Ajouter la capacité des utilisateurs et des équipes à avoir accès « NIVEAU » à une ressource.
pio access list # Montrez à l'ensemble des ressources (ensembles) à un utilisateur ou à une équipe, ainsi qu'à l'accès niveau.
pio access private # Fixer une ressource pour être accessible au secteur privé.
pio access public # Mettre en place une ressource pour être accessible au public.
pio access revoke # Supprimer la capacité des utilisateurs et des équipes à avoir accès à une ressource.
pio boards # Liste des tableaux intégrés préconfigurés.
pio check # Effectuez un contrôle d'analyse statique sur le projet basé sur PlatformIO.
pio debug # Préparer le projet PlatformIO pour le débogage ou le lancement du serveur de débogage.
pio device
pio device list # Lister les appareils disponibles.
pio device monitor # Il s'agit d'une application de console qui fournit un petit terminal application.
pio home # Lancement du serveur Web à domicile.
pio org
pio org add # Ajouter un utilisateur en tant que propriétaire à une organisation.
pio org create # Créer une nouvelle organisation.
pio org destroy # Détruire une organisation et ses équipes.
pio org list # Énumérer les organisations et leurs propriétaires.
pio org remove # Supprimez un utilisateur d'une organisation.
pio org update # Renommer l'organisation ou mettre à jour les détails existants.
pio pkg
pio pkg exec # Exécutez la commande à partir d'un paquet PlatformIO.
pio pkg install # Installer les dépendances du projet ou les paquets personnalisés du registre PlatformIO ou sources extérieures.
pio pkg list # Imprimer sur les colis installés en stdout et leurs dépendances.
pio pkg outdated # Vérifie les paquets de projets périmés et liste les informations relatives à la version pour les dépendances.
pio pkg pack # Créer une boule de tar à partir d'un paquet.
pio pkg publish # Publier un paquet dans le registre PlatformIO afin qu'il puisse être installé par nom.
pio pkg search # Rechercher le registre PlatformIO pour trouver des paquets correspondant à la requête de recherche.
pio pkg show # Afficher les informations sur le paquet provenant du registre PlatformIO.
pio pkg uninstall # Désinstaller les dépendances du projet .
pio pkg unpublish # Il enlève une version de paquet du registre, en supprimant sa saisie et en supprimant la version. boule de tar.
pio pkg update # Mettre à jour les dépendances du projet.
pio project
pio project config # Montrer la configuration calculée sur le projet basé sur "platformio.ini".
pio project init # Initialiser un nouveau projet basé sur PlatformIO ou mettre à jour les données existantes avec de nouvelles données.
pio project metadata # Débosser des métadonnées de construction destinées aux extensions/plugins IDE.
pio remote
PlatformIO Remote Agent # Liste les agents à distance actifs de PlatformIO ont commencé à utiliser leur propre compte PlatformIO.
pio remote device list # Liste des ports de série à distance machines où PlatformIO Remote Agent est mis en marche.
pio remote device monitor # Se connecter au port série de dispositifs distants et recevoir ou envoyer des données en temps réel.
pio remote run # Environnements de processus qui sont définis dans le fichier « plate-forme.ini ».
pio remote test # Exécuter des tests à distance du projet basé sur PlatformIO.
pio remote update # Vérifier ou mettre à jour les plates-formes de développement installées et les plates-formes mondiales Bibliothèques sur la machine distante.
pio run # Exécuter les objectifs du projet sur les environnements déclarés dans « plate-formeio.ini ».
pio settings
pio settings get # Obtenir/liste des paramètres existants
pio settings set # Fixer une nouvelle valeur pour le réglage
pio settings reset # Réinitialiser les paramètres par défaut
pio system
pio system completion install # Installer l'autocomplétion pour: bash, zsh, fish.
pio system completion uninstall # Désintaller l'autocompletion pour : bash, zsh, fish.
pio system info # Display PlatformIO Informations à l'échelle du système.
pio system prune # Supprimer les données non utilisées.
pio test # Exécuter des tests de projet sur une machine hôte (locale) à l'aide de PlatformIO Unit Testing.
pio upgrade # Vérifiez ou mettez à niveau PlatformIO Core vers la dernière version.
Pour avoir plus d'information sur les commandes ci-dessus : https://docs.platformio.org/en/latest/core/userguide/index.html#commands

21
help/help-vimscode Normal file
View file

@ -0,0 +1,21 @@
VIM - Vi IMproved 8.2 - VIMSCODE - IDE Vim 1.0
VimsCode Arguments :
-a Load VimsCode with arduino help
-e Load VimsCode with esp32 help
-p Load VimsCode with platform.io help
VimsCode shortcuts :
<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
<c-s> vertical split of the window
<F10> <F10> close vimscode

14
vimscode.sh Executable file
View file

@ -0,0 +1,14 @@
#!/bin/bash
if [ "$1" = '-a' ] || [ "$1" = '-arduino' ] ; then
vim -p $2 ~/.vim/help/En/help-arduino
elif [ "$1" = '-e' ] || [ "$1" = '-esp' ] ; then
vim -p $2 ~/.vim/help/En/help-esp32
elif [ "$1" = '-p' ] || [ "$1" = '-platform.io' ] ; then
vim -p $2 ~/.vim/help/En/help-platform.io
elif [ "$1" = '' ] || [ "$1" = '' ] ; then
cat ~/.vim/help/help-vimscode
else
echo "Option $1 invalid"
fi