oatmeal

oatmeal

oatmeal werden mit einem vorgefertigten DevContainer geliefert, der über die gesamte Magie verfügt, die für die Arbeit am Projekt erforderlich ist. Wenn Sie jedoch vollständig lokal entwickeln möchten, erhalten Sie im Folgenden alle erforderlichen Tools.

oatmeal cargo cmd setup">

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

Backend hinzufügen

Jedes Backend implementiert das Backend-Merkmal in seiner eigenen Infrastrukturdatei. Das Merkmal enthält eine Dokumentation darüber, was von jeder Methode erwartet wird. Als Beispiel können Sie sich Ollama ansehen.

Die folgenden Schritte sollten ausgeführt werden, um ein Backend hinzuzufügen:

1. Implementieren Sie ein Merkmal für ein neues Backend.
2. Aktualisieren Sie die BackendName-Enumeration mit Ihrem neuen Backend-Namen.
3. Aktualisieren Sie den BackendManager, um Ihr neues Backend bereitzustellen.
4. Schreiben Sie Tests

Einen Editor hinzufügen

Jeder Editor implementiert die Editor-Eigenschaft in seiner eigenen Infrastrukturdatei. Das Merkmal enthält eine Dokumentation darüber, was von jeder Methode erwartet wird. Sie können sich Neovim als Beispiel ansehen.

Um einen Editor hinzuzufügen, müssen die folgenden Schritte ausgeführt werden:

1. Implementieren Sie eine Eigenschaft für einen neuen Editor.
2. Aktualisieren Sie die Enumeration „EditorName“ mit Ihrem neuen Editornamen.
3. Aktualisieren Sie den EditorManager, um Ihren neuen Editor bereitzustellen.
4. Schreiben Sie Tests

Syntaxhervorhebung für eine Sprache hinzufügen

Die Sprachauswahl mit Syntaxhervorhebung ist ein wenig manuell, da mehrere Sprachen kuratiert und dann zu assets.toml hinzugefügt werden müssen.

1. Google sucht auf GitHub nach einem .sublime-syntax Projekt für Ihre Sprache. Fledermaus hat viele!
2. Aktualisieren Sie assets.toml , um das neue Repo einzuschließen. Stellen Sie sicher, dass die Lizenz im Dateiarray enthalten ist. Sie können nix-hash als leere Zeichenfolge belassen und es wird später von einem Betreuer aktualisiert. Wenn Sie Docker installiert haben, können Sie cargo xtask hash-assets ausführen.
3. rm -rf .caches && cargo build
4. Testen Sie, ob die Hervorhebung funktioniert.

FAQ

oatmeal ?

Ich habe eine Schüssel oatmeal gegessen, als ich den ersten Commit geschrieben habe? (Sie erlauben mir nicht mehr, Dinge bei der Arbeit zu benennen ...)

Lizenz

MIT