krz/orgo

Lightning fast org-mode static site generator.

clone: git clone https://gitbay.org/krz/orgo.git

874e528d101afe8c6c14f9558d6df9aa024759e1

unsigned

author: Christian Cleberg <hello@cleberg.net> · 2026-08-11T23:51:10Z

Install from crates.io

`orgo 0.19.1` is published, so the first thing anyone reads no longer has to be
a git clone. `cargo install orgo` leads; building from a checkout stays for
people who want the version they can read.
 README.md        | 10 ++++++++--
 docs/install.org |  8 ++++++++
 2 files changed, 16 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 21c3998..fb7217d 100644
--- a/README.md
+++ b/README.md
@@ -22,14 +22,20 @@ built by orgo, so it doubles as the longest worked example available.
 You need [Rust](https://rustup.rs) (1.88 or newer). Nothing else — syntax highlighting and
 its themes are compiled in.
 
+```sh
+cargo install orgo
+```
+
+Or from a checkout, if you want to build the version you can read:
+
 ```sh
 git clone https://github.com/krazywarez/orgo
 cd orgo
 cargo install --path .
 ```
 
-That puts an `orgo` command on your `PATH`. Full notes, including how to run it without
-installing anything: <https://krazywarez.github.io/orgo/install.html>
+Either way you get an `orgo` command on your `PATH`. Full notes, including how to run it
+without installing anything: <https://krazywarez.github.io/orgo/install.html>
 
 ## Your First Site
 
diff --git a/docs/install.org b/docs/install.org
index 10bdcc3..789631b 100644
--- a/docs/install.org
+++ b/docs/install.org
@@ -10,6 +10,14 @@
 - *Emacs (optional).* Only the differential test suite uses it, to compare output against
   org's own exporter. Nothing about building a site needs Emacs.
 
+* From crates.io
+
+#+BEGIN_SRC sh
+cargo install orgo
+#+END_SRC
+
+That is the whole thing: cargo builds it and puts =orgo= in =~/.cargo/bin=.
+
 * From source
 
 #+BEGIN_SRC sh