aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index c4f7a95..561d17a 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,18 @@ Commands:
platforms Print list of supported platforms (to stdout) and exit
```
+Example flow:
+```
+# Create the project
+sibs new project-name --exec
+cd project-name
+# Build the project in debug mode and run it
+sibs run
+# To compile with optimizations enabled, run:
+# sibs build --release
+# and then the output binary is available in sibs-build/<platform-name>/release/project-name
+```
+
# Examples
Here is a minimal config file:
```