oatmeal

oatmeal

oatmeal est livré avec un DevContainer prêt à l'emploi avec toute la magie nécessaire pour travailler sur le projet. Cependant, si vous souhaitez développer entièrement localement, ce qui suit vous permettra de disposer de tous les outils nécessaires.

oatmeal cargo cmd setup">

cargo install cargo-run-bin
git clone https://github.com/dustinblackman/oatmeal.git
cd oatmeal
cargo cmd setup

Ajout d'un back-end

Chaque backend implémente le trait Backend dans son propre fichier d'infrastructure. Le trait contient une documentation sur ce qui est attendu de chaque méthode. Vous pouvez consulter Ollama à titre d'exemple.

Les étapes suivantes doivent être effectuées pour ajouter un backend :

1. Implémentez le trait pour le nouveau backend.
2. Mettez à jour l’énumération BackendName avec votre nouveau nom de backend.
3. Mettez à jour le BackendManager pour fournir votre nouveau backend.
4. Écrire des tests

Ajout d'un éditeur

Chaque éditeur implémente le trait Editor dans son propre fichier d'infrastructure. Le trait contient une documentation sur ce qui est attendu de chaque méthode. Vous pouvez consulter Neovim à titre d'exemple.

Les étapes suivantes doivent être complétées pour ajouter un éditeur :

1. Implémentez le trait pour le nouvel éditeur.
2. Mettez à jour l’énumération EditorName avec votre nouveau nom d’éditeur.
3. Mettez à jour EditorManager pour fournir votre nouvel éditeur.
4. Écrire des tests

Ajout de coloration syntaxique pour une langue

La sélection de la langue mettant en évidence la syntaxe est un peu manuel dans lequel plusieurs langues doivent être organisées puis ajoutées à assets.toml .

1. Google pour trouver un projet .sublime-syntax sur GitHub pour votre langue. la chauve-souris en a beaucoup !
2. Mettez à jour assets.toml pour inclure le nouveau dépôt. Assurez-vous d'inclure la licence dans le tableau des fichiers. Vous pouvez laisser nix-hash comme chaîne vide, et elle sera mise à jour ultérieurement par un responsable. Ou si Docker est installé, vous pouvez exécuter cargo xtask hash-assets .
3. rm -rf .caches && cargo build
4. Testez pour voir les travaux de mise en valeur.

FAQ

Pourquoi oatmeal ?

Je mangeais un bol de oatmeal lorsque j'ai écrit le premier commit ?. (Ils ne me laissent plus nommer les choses au travail...)

Licence

MIT