Skip to content

Commit

Permalink
📝 README and CONTRIBUTORS updated.
Browse files Browse the repository at this point in the history
  • Loading branch information
yusufcanb committed Feb 27, 2024
1 parent f4ff9be commit 3873e16
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 5 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTORS
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Yusuf Can Bayrak
Ermin Omeragic
Slim Abid
Ermin Omeragic
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,34 @@ tlm is your CLI companion which requires nothing except your workstation. It use

Installation can be done in two ways;

- Installation script (recommended)
- Go Install
- [Installation script](#installation-script) (recommended)
- [Go Install](#go-install)

### Prerequisites

Ollama is needed to download to necessary models. Ollama can be downloaded with the following command:
[Ollama](https://ollama.com/) is needed to download to necessary models.
It can be downloaded with the following methods on different platforms.

- On Linux and macOS;

```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)

- On Windows;

Download instructions can be followed at the following link: [https://ollama.com/download](https://ollama.com/download)

- Or using official Docker images 🐳;

```bash
# CPU Only
docker run -d -v ollama:/root/.ollama -p 11434:11434 --name ollama ollama/ollama

# With GPU (Nvidia only)
docker run -d --gpus=all -v ollama:/root/.ollama -p 11434:11434 --name ollama ollama/ollama"
```
### Installation Script
Installation script is the recommended way to install tlm.
Expand Down

0 comments on commit 3873e16

Please sign in to comment.