From fbfc88aaca4da55c2b17053423645e717a39054d Mon Sep 17 00:00:00 2001
From: thetek42 <git@thetek.de>
Date: Mon, 1 May 2023 13:16:18 +0200
Subject: [PATCH] chore: add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9e2a014
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# Vala + GTK4 Template
+
+This is a simple template for creating GTK4 applications using Vala, LibAdwaita
+and Blueprint.
+
+## Usage
+
+Edit the file `setup-template.sh` to include your name, project name and
+project id. Then, run the script. This will rename everything within the
+template to your desired values.
+
+## Building, Running and Installing
+
+Set up the project build folder (only required once):
+
+```sh
+$ meson setup build
+```
+
+Build the project:
+
+```sh
+$ ninja -C build
+```
+
+Run the program:
+
+```sh
+$ build/src/$PROJECT_NAME
+```
+
+Install the program and resources:
+
+```sh
+$ sudo ninja -C build install
+```