From b535f5087a8056237c20142b6c3c3e1c901138d9 Mon Sep 17 00:00:00 2001 From: "heesk0223@gmail.com" Date: Sun, 31 May 2026 23:47:21 +0900 Subject: [PATCH] Update ReadMe and dependabot.yml --- .github/dependabot.yml | 29 ++++++++++++ README.md | 100 ++++++++++++++++++++++++++--------------- 2 files changed, 92 insertions(+), 37 deletions(-) create mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..25b815b --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,29 @@ +version: 2 + +updates: + - package-ecosystem: 'npm' + directory: '/' + schedule: + interval: 'monthly' + open-pull-requests-limit: 3 + groups: + npm-dependencies: + patterns: + - '*' + labels: + - 'dependencies' + commit-message: + prefix: 'deps' + + - package-ecosystem: 'github-actions' + directory: '/' + schedule: + interval: 'monthly' + groups: + github-actions: + patterns: + - '*' + labels: + - 'dependencies' + commit-message: + prefix: 'deps' diff --git a/README.md b/README.md index d9fa46c..e14db9d 100644 --- a/README.md +++ b/README.md @@ -1,71 +1,97 @@ -# frilingo README +# Frilingo -This is the README for your extension "frilingo". After writing up a brief description, we recommend including the following sections. +Frilingo is a VS Code extension that translates code annotations, comments, and selected text using local AI models powered by Ollama. + +The project aims to provide privacy-friendly and offline-first translation directly inside VS Code without requiring cloud APIs. ## Features -Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. +### Translate Selected Text -For example if there is an image subfolder under your extension project workspace: +Translate the current editor selection using a local Ollama model. -\!\[feature X\]\(images/feature-x.png\) +### Translate Comments and Annotations -> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow. +Quickly translate documentation, comments, and annotations without leaving the editor. -## Requirements +### Local AI Models -If you have any requirements or dependencies, add a section describing those and how to install and configure them. +Use local models through Ollama. -## Extension Settings +Examples: -Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. +- gemma3:4b +- qwen3:4b +- llama3.1 -For example: +### Ollama Integration -This extension contributes the following settings: +Manage local models directly from VS Code. -* `myExtension.enable`: Enable/disable this extension. -* `myExtension.thing`: Set to `blah` to do something. +- Start Ollama +- List installed models +- Pull recommended models +- Check runtime status -## Known Issues +## Requirements -Calling out known issues can help limit users opening duplicate issues against your extension. +### Install Ollama -## Release Notes +Download and install Ollama: -Users appreciate release notes as you update your extension. +https://ollama.com/download -### 1.0.0 +### Pull a Model -Initial release of ... +Example: -### 1.0.1 +```bash +ollama pull gemma3:4b +``` -Fixed issue #. +## Development -### 1.1.0 +Install dependencies: -Added features X, Y, and Z. +```bash +npm install +``` ---- +Run type checking: -## Following extension guidelines +```bash +npm run check-types +``` -Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension. +Run lint: -* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines) +```bash +npm run lint +``` -## Working with Markdown +Run smoke test: -You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: +```bash +npm run test:ollama +``` + +## Roadmap + +- [x] Ollama integration +- [x] Selection translation +- [x] Model management +- [ ] Hover translation +- [ ] Inline replacement +- [ ] Multiple language support +- [ ] Translation caching +- [ ] User settings + +## Known Issues -* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux). -* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux). -* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets. +Some reasoning-oriented models may generate explanations instead of direct translations. -## For more information +For translation-focused workflows, models such as gemma3 are recommended. -* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) -* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/) +## License -**Enjoy!** +MIT