feature: docs have been moved to github pages (#108)

- Docs are now at this link: https://mattkae.github.io/miracle-wm-wiki/

README.md

@@ -10,79 +10,10 @@
 window manager at its core, very much in the style of [i3](https://i3wm.org/) and [sway](https://github.com/swaywm/sway).
 The intention is to build a compositor that is flashier and more feature-rich than either of those compositors, like [swayfx](https://github.com/WillPower3309/swayfx).
 
-Please see the [roadmap](./ROADMAP.md) document for the current status and direction of the project.
-
 ![miracle in action](./resources/screenshot1.png "miracle in action")
 
-# Install
-```sh
-# snap
-sudo snap install miracle-wm --classic
-
-# deb (jammy, mantic, or noble)
-sudo add-apt-repository ppa:matthew-kosarek/miracle-wm
-sudo apt update
-sudo apt install miracle-wm
-```
-
-Or for the nightly build:
-```sh
-sudo snap install miracle-wm --classic --edge
-```
-
-> [!NOTE]
-> While the project is only built as a snap at this moment, I am not allergic to other packaging formats, just perhaps
-> too lazy to implement them at this moment. I will happily accept contributions in this domain.
-
-
-# Dependencies
-- [cmake](https://cmake.org/) >= 3.7
-- [gcc](https://gcc.gnu.org/) or [clang](https://clang.llvm.org/) with C++20 support
-- [miral](https://canonical-mir.readthedocs-hosted.com/stable/getting_and_using_mir/) >= 6
-- [mir-graphics-drivers-desktop](https://canonical-mir.readthedocs-hosted.com/stable/getting_and_using_mir/) >= 2.14
-- [mir-graphics-drivers-nvidia](https://canonical-mir.readthedocs-hosted.com/stable/getting_and_using_mir/) >= 2.14 (NVIDIA Only)
-- [glib-2.0](https://docs.gtk.org/glib/)
-- [yaml-cpp](https://github.com/jbeder/yaml-cpp)
-- [libevdev](https://www.freedesktop.org/wiki/Software/libevdev/)
-- [nlohmann json](https://github.com/nlohmann/json) >= 3.2.0
-- [libnotify](https://gitlab.gnome.org/GNOME/libnotify)
-- [libxkbcommon-devel](https://github.com/xkbcommon/libxkbcommon)
-
-# Building
-**From Source**:
-```sh
-git clone https://github.com/mattkae/miracle-wm.git
-cd miracle-wm
-
-cmake -Bbuild
-cmake --build build
-WAYLAND_DISPLAY=wayland-98 ./build/bin/miracle-wm
-```
-
-**Snap**:
-```sh
-cd miracle-wm
-snapcraft
-sudo snap install --dangerous --classic miracle-wm_*.snap
-```
-
-# Running
-
-**On login**:
-
-Once installed, you may select the "Miracle" option from your display manager before you login (e.g. GDM or LightDM).
-In most environments, this presents itself as a little "settings" button after you select your name.
-
-Note that if you installed the snap, the option may read "Miracle (snap)" to distinguish it from the binary version.
-
-**Hosted**:
-
-To run the window manager as a window on your current desktop session, simply run:
-```sh
-WAYLAND_DISPLAY=wayland-98 miracle-wm
-```
 
-Note that this is only useful if you want to test-drive the window manager or do some development on it for yourself.
+# User Guide
+For all information related to `miracle-wm`, including installation instructions, build instructions,
+and a roadmap, visit: https://mattkae.github.io/miracle-wm-wiki/
 
-# Usage
-See the [user guide](USERGUIDE.md) for info on how to use `miracle-wm`.