aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1f9302a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Myn
+
+Just do
+
+```bash
+$ cmake --preset=debug
+```
+To build the project in debug mode.
+
+For release mode, use
+
+```bash
+$ cmake --preset=release
+```
+
+To build the project itself
+```bash
+$ cmake --build build
+```
+
+And done, see that was easy.