From efa4e290ce82b09ca62c01ee08f18791e22ddbf8 Mon Sep 17 00:00:00 2001
From: mirkobrombin <send@mirko.pm>
Date: Mon, 5 Sep 2022 12:38:57 +0200
Subject: [PATCH] add readme

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b52d9ee
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Ubuntu Smoother
+This utility is meant to be used in [Ubuntu Vanilla GNOME](https://github.com/mirkobrombin/ubuntu-vanilla-gnome) 
+as a first-setup wizard. It's purpose is to help the user to configure the 
+system to his needs, e.g. by configuring snap, flatpak, flathub, etc.
+
+
+## Build
+### Dependencies
+- build-essential
+- meson
+- libadwaita-1-dev
+- gettext
+- desktop-file-utils
+
+### Build
+```bash
+meson build
+ninja -C build
+```
+
+### Install
+```bash
+sudo ninja -C build install
+```
+
+## Run
+```bash
+ubuntu-smoother
+```
\ No newline at end of file