oatmeal

oatmeal

oatmeal vem com um DevContainer pronto com toda a magia necessária para trabalhar no projeto. No entanto, se você deseja desenvolver totalmente local, o seguinte irá ajudá-lo a configurar todas as ferramentas necessárias.

oatmeal cargo cmd setup">

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

Adicionando um back-end

Cada backend implementa a característica Backend em seu próprio arquivo de infraestrutura. A característica possui documentação sobre o que se espera de cada método. Você pode verificar Ollama como exemplo.

As etapas a seguir devem ser concluídas para adicionar um back-end:

1. Implementar característica para novo back-end.
2. Atualize o enum BackendName com seu novo nome de back-end.
3. Atualize o BackendManager para fornecer seu novo back-end.
4. Escreva testes

Adicionando um editor

Cada editor implementa a característica Editor em seu próprio arquivo de infraestrutura. A característica possui documentação sobre o que se espera de cada método. Você pode verificar o Neovim como exemplo.

As etapas a seguir devem ser concluídas para adicionar um editor:

1. Implementar característica para o novo editor.
2. Atualize o enum EditorName com seu novo nome de Editor.
3. Atualize o EditorManager para fornecer seu novo editor.
4. Escreva testes

Adicionando destaque de sintaxe para um idioma

A seleção de idioma de destaque de sintaxe é um pequeno manual onde vários idiomas devem ser selecionados e adicionados a assets.toml .

1. Google para encontrar um projeto .sublime-syntax no GitHub para o seu idioma. morcego tem muitos!
2. Atualize assets.toml para incluir o novo repositório. Certifique-se de incluir a licença na matriz de arquivos. Você pode deixar nix-hash como uma string vazia e ela será atualizada por um mantenedor posteriormente. Ou se você tiver o docker instalado, poderá executar cargo xtask hash-assets .
3. rm -rf .caches && cargo build
4. Teste para ver trabalhos de destaque.

Perguntas frequentes

Por que oatmeal ?

Eu estava comendo uma tigela de oatmeal quando escrevi o primeiro commit?. (Eles não me deixam mais nomear as coisas no trabalho...)

Licença

MIT