docs: Complete README with full toolchain overview

2026-02-24 20:36:58 +00:00 · 2026-02-24 20:36:58 +00:00 · 7c1bcef395
commit 7c1bcef395
parent 9d73e6390c
1 changed files with 95 additions and 25 deletions
--- a/README.md
+++ b/README.md
@ -1,37 +1,107 @@
-# IX-Tools — Community Tools for Inference-X
+# ix-tools — Inference-X Community Toolchain

-Public tools, governance documents, and utilities for the [Inference-X](https://inference-x.com) ecosystem.
+**Tools, scripts, and source files for the Inference-X ecosystem.**

-> **Inference-X** is the universal AI inference engine — 19 hardware backends, 228KB binary, runs anywhere. Community-owned, creator-protected.
+Built in Morocco · Community-maintained · MIT License
+
+---

 ## Repository Structure

-| Directory | Content |
-|-----------|---------|
-| `docs/` | Architecture, manifesto, provider framework, revenue model |
-| `governance/` | Community governance and contribution levels |
-| `license/` | SALKA-IX License v1.0 |
-| `watermark/` | Attribution standard for all IX ecosystem projects |
-
-## Quick Start
-
-```bash
-# Clone the engine
-git clone https://git.inference-x.com/elmadani/inference-x.git
-
-# Clone community tools
-git clone https://git.inference-x.com/elmadani/ix-tools.git
+```
+ix-tools/
+│
+├── site/                      # Frontend source files
+│   ├── vitrine/               # inference-x.com (site vitrine)
+│   │   └── index.html         # Main site — community portal
+│   └── saas/                  # build.inference-x.com
+│       ├── index.html         # SaaS frontend (demo + repos + builder)
+│       └── demo_module.js     # Free demo backend module
+│
+├── tools/                     # Developer tools
+│   ├── builder/               # IX config builder
+│   ├── organ/                 # Organ store API client
+│   ├── forge/                 # Model forge (quantize, convert, package)
+│   ├── store/                 # Community model store tools
+│   └── compilation/           # Cross-platform build scripts
+│
+├── scripts/                   # Deployment & operations
+│   ├── install.sh             # Universal installer
+│   ├── deploy-oasis.sh        # Deploy to OASIS VPS
+│   ├── deploy-arche.sh        # Deploy to ARCHE VPS
+│   └── monitor.sh             # Health monitoring
+│
+└── docs/                      # Documentation
+    ├── ARCHITECTURE.md        # System architecture
+    ├── API.md                 # API reference
+    └── CONTRIBUTING.md        # How to contribute
 ```

-## Community
+---

- Website: [inference-x.com](https://inference-x.com)
- Git: [git.inference-x.com](https://git.inference-x.com)
- Build: [build.inference-x.com](https://build.inference-x.com)
+## Tools Overview
+
+### 🔧 Builder
+Generates ready-to-run `ix-config.json` for any hardware combination.  
+Supports: CPU/CUDA/Metal/Vulkan/ROCm/OpenCL × Linux/macOS/Windows × ARM/x86
+
+### 🫀 Organ Store  
+Tools to package, publish, and install IX "organs" — pre-configured AI personas.  
+Format: `organ.json` + GGUF model + system prompt + config
+
+### ⚒ Forge
+Model conversion and quantization pipeline:
+- GGUF conversion from HuggingFace SafeTensors
+- Q4/Q5/Q8/F16 quantization
+- Model packaging for the Store
+
+### 🏪 Store Client
+CLI and API client for the IX community model store:
+- Browse, download, install models
+- Publish your own trained/fine-tuned models
+- Rate and review
+
+### 🔨 Compilation
+Cross-platform build scripts for the IX engine:
+```bash
+./tools/compilation/build-linux-x64.sh
+./tools/compilation/build-macos-arm64.sh
+./tools/compilation/build-windows-x64.sh
+./tools/compilation/build-raspberry.sh
+```
+
+---
+
+## Quick Install
+
+```bash
+# Universal installer
+curl -fsSL https://inference-x.com/install.sh | bash
+
+# Manual
+git clone https://git.inference-x.com/elmadani/ix-tools
+cd ix-tools
+./scripts/install.sh
+```
+
+---
+
+## Contributing
+
+1. Fork this repo on `git.inference-x.com`
+2. Create a branch: `git checkout -b feature/my-tool`
+3. Submit a PR
+4. A craton administrator reviews
+
+**Craton system**: The 11 geological cratons each have an administrator who reviews contributions from their region. See [11 Cratons](https://inference-x.com#join).
+
+---

 ## License

-SALKA-IX License v1.0 — Free for the IX ecosystem. Commercial use requires a license.  
-See [license/SALKA-IX-LICENSE.md](license/SALKA-IX-LICENSE.md)
+MIT — Free for all use, commercial and personal.  
+The IX engine itself uses the [SALKA-IX License](https://git.inference-x.com/elmadani/inference-x).

-**Creator:** Elmadani Salka · All rights reserved
+---
+
+*Built by the Anti-Atlas craton — continuing the work of the khettara builders.*