search

twinnydotdev / twinny

The most no-nonsense, locally or API-hosted AI code completion plugin for Visual Studio Code - like GitHub Copilot but completely free and 100% private.
https://twinny.dev
MIT License
2.93k stars 154 forks source link

Improve docs with step by step setup #164

Closed onel closed 7 months ago

onel commented 7 months ago

First of all, great job on the extension.

Is your feature request related to a problem? Please describe. The current docs do a very job of describing what the project is and how to install the extension. But as a newcomer to running models locally I got stuck in some places.

Describe the solution you'd like I wanna improve the docs with a step by step + commands of how to get started and how to use the extension. Optionally, I would propose a table of what model are recommended for certain hardware.

I can make the changes but I'm opening the issue to discuss before.

rjmacarthy commented 7 months ago

Hey, feel free to create more detailed documentation if you found anything you got stuck on and think it would be of help to others. I would be grateful for it.

Many thanks,

onel commented 7 months ago

Fixed with #165