oatmeal

oatmeal

oatmealプロジェクトの作業に必要なすべての魔法が備わった既製の DevContainer が付属しています。ただし、完全にローカルで開発したい場合は、次の手順で必要なツールをすべてセットアップできます。

oatmeal cargo cmd setup">

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

バックエンドの追加

各バックエンドは、独自のインフラストラクチャ ファイルにバックエンド特性を実装します。トレイトには、各メソッドに期待される内容に関するドキュメントが含まれています。例として Ollama をチェックアウトできます。

バックエンドを追加するには、次の手順を完了する必要があります。

1. 新しいバックエンドの特性を実装します。
2. BackendName 列挙型を新しいバックエンド名で更新します。
3. 新しいバックエンドを提供するために BackendManager を更新します。
4. テストを書く

エディタの追加

各エディターは、独自のインフラストラクチャ ファイルにエディター特性を実装します。トレイトには、各メソッドに期待される内容に関するドキュメントが含まれています。例として Neovim をチェックアウトできます。

エディタを追加するには、次の手順を完了する必要があります。

1. 新しいエディターにトレイトを実装します。
2. EditorName 列挙型を新しいエディター名で更新します。
3. EditorManager を更新して、新しいエディターを提供します。
4. テストを書く

言語の構文強調表示の追加

構文ハイライト言語の選択は、いくつかの言語を厳選してから、 assets.tomlに追加する必要がある、ちょっとしたマニュアルです。

1. Google で、GitHub 上であなたの言語の.sublime-syntaxプロジェクトを見つけてください。バットにはたくさんあります！
2. 新しいリポジトリを含めるために、 assets.toml更新します。ファイル配列にライセンスを必ず含めてください。 nix-hash空の文字列のままにしておくことができ、後でメンテナによって更新されます。または、docker がインストールされている場合は、 cargo xtask hash-assets実行できます。
3. rm -rf .caches && cargo build
4. ハイライトが機能するかどうかをテストしてください。

よくある質問

なぜoatmealのか？

最初のコミットを書いたとき、私はoatmeal一杯食べていました。 (職場ではもう名前を言うことは許されません...)

ライセンス

マサチューセッツ工科大学