From 7027d0508cb4ed06170e354d11b7c9333eb665e6 Mon Sep 17 00:00:00 2001 From: Rafael Bradley Date: Sun, 10 Aug 2025 21:34:02 -0300 Subject: [PATCH] Add README with guide to the docs --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f5e8469 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# Payphone + +To read the documentation, run + +```shell +$ git clone --branch rewrite https://git.nyeki.dev/payphone/payphone.git +$ cd payphone +$ cargo doc --open --no-deps +```