oatmeal

oatmeal

oatmeal comes with a ready made DevContainer with all the magic needed to work on the project. However if you wish to develop fully local, the following will get you set up with all the necessary tooling.

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

Adding a backend

Each backend implements the Backend trait in its own infrastructure file. The trait has documentation on what is expected of each method. You can checkout Ollama as an example.

The following steps should be completed to add a backend:

1. Implement trait for new backend.
2. Update the BackendName enum with your new Backend name.
3. Update the BackendManager to provide your new backend.
4. Write tests

Adding an editor

Each editor implements the Editor trait in its own infrastructure file. The trait has documentation on what is expected of each method. You can checkout Neovim as an example.

The following steps should be completed to add an editor:

1. Implement trait for new editor.
2. Update the EditorName enum with your new Editor name.
3. Update the EditorManager to provide your new editor.
4. Write tests

Adding syntax highlighting for a language

Syntax highlighting language selection is a tad manual where several languages must be curated and then added to assets.toml.

1. Google to find a .sublime-syntax project on GitHub for your language. bat has many!
2. Update assets.toml to include the new repo. Make sure to include the license in the files array. You can leave nix-hash as an empty string, and it'll be updated by a maintainer later. Or if you have docker installed, you can run cargo xtask hash-assets.
3. rm -rf .caches && cargo build
4. Test to see highlighting works.

FAQ

Why oatmeal?

I was eating a bowl of oatmeal when I wrote the first commit ?. (They don't let me name things at work anymore...)

License

MIT