Skip to content

Commit

Permalink
Merge pull request #5 from eomeragic1/eomeragic1/contribute
Browse files Browse the repository at this point in the history
Updated README and added contribution
  • Loading branch information
yusufcanb authored Feb 27, 2024
2 parents e1349ca + 573d98a commit f4ff9be
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
3 changes: 2 additions & 1 deletion CONTRIBUTORS
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
Yusuf Can Bayrak
Slim Abid
Ermin Omeragic
Slim Abid
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# tlm - Local terminal companion, powered by CodeLLaMa.

tlm is your CLI companion which requires nothing then your workstation. It uses most efficient and powerful [CodeLLaMa](https://ai.meta.com/blog/code-llama-large-language-model-coding/) in your local environment to provide you the best possible command line suggestions.
tlm is your CLI companion which requires nothing except your workstation. It uses most efficient and powerful [CodeLLaMa](https://ai.meta.com/blog/code-llama-large-language-model-coding/) in your local environment to provide you the best possible command line suggestions.

![Suggest](./assets/suggest.gif)

Expand All @@ -26,6 +26,13 @@ Installation can be done in two ways;
- Installation script (recommended)
- Go Install

### Prerequisites

Ollama is needed to download to necessary models. Ollama can be downloaded with the following command:
```bash
curl -fsSL https://ollama.com/install.sh | sh
```
Windows users can download Ollama at the following link: [https://ollama.com/download](https://ollama.com/download)
### Installation Script

Installation script is the recommended way to install tlm.
Expand All @@ -50,7 +57,7 @@ Invoke-RestMethod -Uri https://raw.githubusercontent.com/yusufcanb/tlm/main/inst

### Go Install

If you Go 1.21 or higher installed on your system, you can easily use the following command to install tlm;
If you have Go 1.21 or higher installed on your system, you can easily use the following command to install tlm;

```bash
go install github.com/yusufcanb/tlm@latest
Expand Down

0 comments on commit f4ff9be

Please sign in to comment.