From c0afe2bac60c18cf25b8d5fa9aa9ac193ab952e4 Mon Sep 17 00:00:00 2001
From: David Timber <dxdt@dev.snart.me>
Date: Fri, 1 Nov 2024 17:01:50 +0100
Subject: Fix crash bug, update doc

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 0a02297..a28345f 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,37 @@
 The X11 bouncing DVD logo. A little gimmick for a new video.
 
 ![Screen capture of xbouncing in action](doc/animated.webp)
+
+## Cloud Demo
+If you're running Linux, you can simply use SSH X11 forwarding to try it out
+without installing anything at all. However, due to network delay, it won't be
+as smooth as running it on your machine locally.
+
+```
+ssh -X dvd@sshs.snart.me
+```
+
+If you're running Mac or Windows, you may use **XQuartz** or **Xming**.
+
+## INSTALL
+To build it from source and run it on your machine yourself,
+
+```sh
+sudo dnf install git cmake gcc libX11-devel libXrandr-devel
+
+git clone https://github.com/dxdxdt/xbouncing
+cd xbouncing
+
+cmake -B build
+cd build
+
+make
+sudo make install
+```
+
+## Usage
+```sh
+xbouncing
+```
+
+Interrupt(`Ctrl` + `C`) or terminate.
-- 
cgit