Skip to content

Commit

Permalink
Merge pull request #410 from janhq/409-feat-reduce-the-usage-of-insta…
Browse files Browse the repository at this point in the history
…llation-scripts-and-pointing-users-to-just-use-the-binary

docs: remove the quickstart using bash script
  • Loading branch information
tikikun authored Feb 2, 2024
2 parents 26ef264 + d60bda5 commit a4bf3cf
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 15 deletions.
8 changes: 7 additions & 1 deletion docs/docs/new/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ description: How to install Nitro
keywords: [Nitro, Jan, fast inference, inference server, local AI, large language model, OpenAI compatible, open source, llama]
---

# Notices

Nitro is an extremely simple program compiled into a single binary, you are encouraged to go directly to the releases page of Nitro and just download a binary and use. The below installation process is just for the purpose of being a "helper" script that does not guarantee working.

You can find releases page of nitro at at [Release](https://github.com/janhq/nitro/releases).

# Nitro Installation Guide

This guide provides instructions for installing Nitro using the provided [install.sh](https://github.com/janhq/nitro/blob/main/install.sh) and [install.bat](https://github.com/janhq/nitro/blob/main/install.bat) scripts for Linux, macOS, and Windows systems.
Expand Down Expand Up @@ -181,4 +187,4 @@ Simple testcase with nitro, after starting the server, you can run the following
## Uninstallation
- **Linux and macOS**: Run `sudo uninstall_nitro.sh` from anywhere (the script is added to PATH).
- **Windows**: Open PowerShell and run `uninstallnitro.bat` from anywhere (the script is added to PATH).
- **Windows**: Open PowerShell and run `uninstallnitro.bat` from anywhere (the script is added to PATH).
18 changes: 4 additions & 14 deletions docs/docs/new/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,13 @@ Download and install Nitro on your system.

### From the release page

> [Nitro Release Page](https://github.com/janhq/nitro/releases)
### For Linux and MacOS

```bash
curl -sfL https://raw.githubusercontent.com/janhq/nitro/main/install.sh | sudo /bin/bash -
```
You can directly choose the pre-built binary that compatible with your system at

### For Windows

```bash
powershell -Command "& { Invoke-WebRequest -Uri 'https://raw.githubusercontent.com/janhq/nitro/main/install.bat' -OutFile 'install.bat'; .\install.bat; Remove-Item -Path 'install.bat' }"
```
> [Nitro Release Page](https://github.com/janhq/nitro/releases)
> Installing Nitro will add new files and configurations to your system to enable it to run.
After you have downloaded the binary, you can directly use the binary with "./nitro".

For a manual installation process, see: [Install from Source](install.md)
If you want to build from source rather than using the pre-built binary, you can also check: [Build from Source](build-source.md)

## Step 2: Downloading a Model

Expand Down

0 comments on commit a4bf3cf

Please sign in to comment.