From f4373f8a4569611d34ca51e0ff3dc0cc4aff8262 Mon Sep 17 00:00:00 2001 From: jason-fxz Date: Tue, 18 Aug 2026 16:09:32 -0700 Subject: [PATCH] docs(README): add install commands to Getting Started --- README.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f039371..9fe4ebd 100644 --- a/README.md +++ b/README.md @@ -25,10 +25,27 @@ FreeToken is an edge-native Mixture-of-Experts (MoE) serving engine designed for ## Getting Started -**Desktop app** — download FreeToken for Windows or Linux at -[flashml.ai](https://www.flashml.ai/). It sets the engine up for you and gives you a GUI for running models, chatting, and tuning the engine. +### Desktop app -**CLI**: +Download FreeToken for Windows or Linux at [flashml.ai](https://www.flashml.ai/). It sets the engine up for you and gives you a GUI for running models, chatting, and tuning the engine. + +### CLI + +Install FreeToken with [uv](https://docs.astral.sh/uv/) (recommended) or pip: + +```bash +uv pip install "freetoken[accel]" +``` + +Or build from source: + +```bash +git clone https://github.com/FlashML-org/FreeToken.git && cd FreeToken +uv venv && source .venv/bin/activate +uv pip install -e ".[accel]" +``` + +For More details: - [Install FreeToken](docs/install.md) - [Quick start](docs/quickstart.md)