From 247b8a3c5b543ba974a8d31cb4a8fc88825928d5 Mon Sep 17 00:00:00 2001 From: Extraltodeus Date: Wed, 15 Jul 2026 23:03:48 +0200 Subject: [PATCH] Enhance README with installation and usage sections Added detailed sections for installation, usage, and project layout in the README. --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index e07ad4a..c680a97 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,27 @@ ship**.

Introducing non-expert friendly alignment!

+--- + +- [What it's built on](#what-its-built-on) +- [Installation](#installation) + - [Native](#native) + - [Docker](#docker) +- [Running](#running) +- [Usage](#usage) + - [1. Load a model](#1-load-a-model) + - [2. Load a Jacobian lens](#2-load-a-jacobian-lens) + - [3. Chat with the live lens](#3-chat-with-the-live-lens) + - [4. Edit tokens ☢](#4-edit-tokens-) + - [5. Export the edit](#5-export-the-edit) + - [6. Fit your own lens](#6-fit-your-own-lens) +- [CLI (no UI)](#cli-no-ui) +- [Project layout](#project-layout) +- [Notes](#notes) +- [Final words](#final-words) +- [Credits](#credits) +- [License](#license) + --- ## What it's built on