Skip to content

Commit 3781cd3

Browse files
author
sqlopt
committed
docs(site+readme): lead with prebuilt 3-platform downloads, not git clone
End users shouldn't have to build from source. Surface the release installers: - README: a Download table (Windows .zip, macOS .dmg for Apple Silicon & Intel, Linux .AppImage/.tar.gz) → release assets; build-from-source demoted below. - Landing page: hero CTA now scrolls to a Download section with per-OS buttons (macOS arm64/intel, Windows, Linux) pointing at releases/latest/download; removed the git-clone command + its copy-button JS.
1 parent 10c5605 commit 3781cd3

2 files changed

Lines changed: 27 additions & 14 deletions

File tree

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,19 @@ cloud model.
4141
4242
---
4343

44+
## Download
45+
46+
Prebuilt — **no toolchain needed**. Grab the installer for your OS:
47+
48+
| Platform | Download |
49+
|---|---|
50+
| **Windows** (x64) | **[portable `.zip`](https://github.com/singhpratech/dbopt/releases/latest/download/sqlopt-windows-x86_64.zip)** |
51+
| **macOS** (Apple Silicon) | **[`.dmg`](https://github.com/singhpratech/dbopt/releases/latest/download/sqlopt-macos-arm64.dmg)** |
52+
| **macOS** (Intel) | **[`.dmg`](https://github.com/singhpratech/dbopt/releases/latest/download/sqlopt-macos-x86_64.dmg)** |
53+
| **Linux** (x64) | **[`.AppImage`](https://github.com/singhpratech/dbopt/releases/latest/download/sqlopt-linux-x86_64.AppImage)** · [`.tar.gz`](https://github.com/singhpratech/dbopt/releases/latest/download/sqlopt-linux-x86_64.tar.gz) |
54+
55+
Each is a **single self-contained binary** (the web UI is embedded) — run it, then open `http://127.0.0.1:3690`. Checksums and all builds on the [releases page](https://github.com/singhpratech/dbopt/releases).
56+
4457
## Why it exists
4558

4659
Slow SQL is the silent tax on every data-heavy company: the query "that's been running since last night,"
@@ -87,7 +100,9 @@ preview-only (Safe-Apply never auto-runs a change).
87100
cargo run -p eval -- --html # → target/eval-report.html (the live board)
88101
```
89102

90-
## Quick start
103+
## Build from source
104+
105+
Prefer to build it yourself (or hacking on dbopt)? You'll need Rust, Node 18+ and `wasm-pack`:
91106

92107
```bash
93108
# Build the web UI first (it is embedded into the backend binary at compile time).

docs/index.html

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@
228228
<h1 class="reveal" style="transition-delay:.06s">Find &amp; fix slow SQL<br><span class="hl">before</span> it reaches production.</h1>
229229
<p class="sub reveal" style="transition-delay:.12s">dbopt reads your T-SQL, your execution plans, and your live server metrics — then tells you exactly what's going to hurt and <b>how to fix it, with the reasoning cited</b>. Statically. Privately. No execution, no locks, no load on prod.</p>
230230
<div class="cta-row reveal" style="transition-delay:.18s">
231-
<a class="btn btn-primary" href="https://github.com/singhpratech/dbopt" target="_blank" rel="noopener">Get dbopt — free &amp; open →</a>
231+
<a class="btn btn-primary" href="#get">Download — free &amp; open →</a>
232232
<a class="btn btn-ghost" href="#lenses">See how it works</a>
233233
</div>
234234
<div class="status reveal" style="transition-delay:.26s">
@@ -357,13 +357,17 @@ <h2 style="font-size:clamp(24px,3vw,32px)">SQL Server today. Postgres &amp; MySQ
357357
<div class="wrap">
358358
<span class="kicker reveal" style="justify-content:center">Ready when you are</span>
359359
<h2 class="reveal" style="transition-delay:.06s;margin-top:16px">Stop guessing.<br>Start <span class="hl">seeing</span>.</h2>
360-
<div class="install reveal" style="transition-delay:.12s">
361-
<code id="cmd"><span class="p">$</span> git clone https://github.com/singhpratech/dbopt &amp;&amp; cargo build --release</code>
362-
<button id="copy">COPY</button>
363-
</div>
364-
<div class="cta-row reveal" style="transition-delay:.16s;justify-content:center;margin-top:24px">
365-
<a class="btn btn-primary" href="https://github.com/singhpratech/dbopt" target="_blank" rel="noopener">View on GitHub ↗</a>
360+
<div class="cta-row reveal" style="transition-delay:.12s;justify-content:center;margin-top:30px;flex-wrap:wrap">
361+
<a class="btn btn-primary" href="https://github.com/singhpratech/dbopt/releases/latest/download/sqlopt-macos-arm64.dmg">macOS · Apple Silicon</a>
362+
<a class="btn btn-ghost" href="https://github.com/singhpratech/dbopt/releases/latest/download/sqlopt-macos-x86_64.dmg">macOS · Intel</a>
363+
<a class="btn btn-ghost" href="https://github.com/singhpratech/dbopt/releases/latest/download/sqlopt-windows-x86_64.zip">Windows</a>
364+
<a class="btn btn-ghost" href="https://github.com/singhpratech/dbopt/releases/latest/download/sqlopt-linux-x86_64.AppImage">Linux</a>
366365
</div>
366+
<p class="reveal" style="transition-delay:.18s;text-align:center;margin-top:20px;font:12px var(--mono);color:var(--dim)">
367+
one self-contained binary · run it, open <span style="color:var(--muted)">127.0.0.1:3690</span> &nbsp;·&nbsp;
368+
<a href="https://github.com/singhpratech/dbopt/releases" style="color:var(--muted)">all releases</a> &nbsp;·&nbsp;
369+
<a href="https://github.com/singhpratech/dbopt" style="color:var(--muted)">build from source ↗</a>
370+
</p>
367371
</div>
368372
</section>
369373

@@ -397,12 +401,6 @@ <h2 class="reveal" style="transition-delay:.06s;margin-top:16px">Stop guessing.<
397401
requestAnimationFrame(step);
398402
}),{threshold:.5});
399403
document.querySelectorAll('[data-count]').forEach(el=>cu.observe(el));
400-
// copy install
401-
const btn=document.getElementById('copy');
402-
btn.addEventListener('click',async()=>{
403-
try{await navigator.clipboard.writeText('git clone https://github.com/singhpratech/dbopt && cargo build --release');
404-
btn.textContent='COPIED ✓';setTimeout(()=>btn.textContent='COPY',1400);}catch{}
405-
});
406404
</script>
407405
</body>
408406
</html>

0 commit comments

Comments
 (0)