From 24db01f2a7987d933d6272f9f7091c2dd691905c Mon Sep 17 00:00:00 2001
From: Fabian Peddinghaus
Date: Tue, 7 Jul 2026 18:03:08 +0200
Subject: [PATCH] Restructure README layout
Move the hero figure from the top of the page into the Benchmarks
section, replacing the quality and scaling plots. The intro paragraphs
now follow the badges directly, and the Installation section gains a
pip install straight from GitHub alongside the PyPI release.
---
README.md | 25 +++++++++++--------------
1 file changed, 11 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
index ccce04b..36b5498 100644
--- a/README.md
+++ b/README.md
@@ -10,13 +10,6 @@
-
-
-
-
-
-
-
OmniMalloc is a Python library for static memory allocation: given buffers
with known sizes and lifetimes, assign offsets so that peak memory is minimized.
This is the memory-planning step at the heart of ML compilers, embedded
@@ -30,10 +23,18 @@ tools to develop and evaluate new allocation strategies.
## Installation
+Install the latest release from PyPI:
+
```bash
pip install omnimalloc
```
+Or install the development version directly from GitHub:
+
+```bash
+pip install git+https://github.com/fpedd/omnimalloc.git
+```
+
## Usage
```python
@@ -68,16 +69,12 @@ allocation sources, and benchmarking.
-
-
-
-
-
-
+
+
-Every figure on this page is generated from a deterministic benchmark run by
+All figures on this page are generated from a deterministic benchmark run by
[`scripts/generate_readme_assets.py`](scripts/generate_readme_assets.py).
Run your own campaigns with the [benchmark harness](examples/05_benchmark.py).