diff --git a/README.md b/README.md index d9fa46c..2d0ab6e 100644 --- a/README.md +++ b/README.md @@ -1,71 +1,116 @@ -# frilingo README +# Frilingo -This is the README for your extension "frilingo". After writing up a brief description, we recommend including the following sections. +Translate code, errors, and documentation directly inside VSCode. + +🚧 Early development stage + +Frilingo helps developers understand code, error messages, comments, documentation, and technical content in their preferred language using local LLMs through Ollama. ## 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 selected text directly inside VSCode. -\!\[feature X\]\(images/feature-x.png\) +```text +Select text +↓ +Run command +↓ +Receive translated result +``` -> 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. +### Generate Code Comments -## Requirements +Generate clear and readable code comments from selected code. + +```ts +const count = map.entry(word).orInsert(0); +``` + +```ts +// Return the existing value for the key. +// Insert 0 when the key does not exist. +const count = map.entry(word).orInsert(0); +``` + +### Local LLM Support -If you have any requirements or dependencies, add a section describing those and how to install and configure them. +Frilingo works with local models through Ollama. -## Extension Settings +Supported models include: -Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. +- EXAONE +- Qwen +- DeepSeek +- Any Ollama-compatible model -For example: +### Korean-First Workflow -This extension contributes the following settings: +Frilingo is designed for developers who frequently work with: -* `myExtension.enable`: Enable/disable this extension. -* `myExtension.thing`: Set to `blah` to do something. +- English documentation +- Compiler errors +- Open source projects +- Technical discussions -## Known Issues +## Roadmap -Calling out known issues can help limit users opening duplicate issues against your extension. +### v0.1 -## Release Notes +- Translate selected text +- Ollama integration +- EXAONE support -Users appreciate release notes as you update your extension. +### v0.2 -### 1.0.0 +- Activity Bar panel +- Translation history -Initial release of ... +### v0.3 -### 1.0.1 +- Comment generation + +### v0.4 + +- Multi-language support + +### v1.0 + +- Marketplace release + +## Requirements -Fixed issue #. +- VSCode +- Node.js 22+ +- Ollama -### 1.1.0 +## Development -Added features X, Y, and Z. +Install dependencies: ---- +```bash +npm install +``` -## Following extension guidelines +Run extension host: -Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension. +```bash +F5 +``` -* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines) +Build project: -## Working with Markdown +```bash +npm run compile +``` -You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: +## Contributing -* 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. +Contributions are welcome. -## For more information +Please read the contributing guide before submitting a pull request. -* [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