aboutsummaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
authorJeroen van Rijn <Kelimion@users.noreply.github.com>2024-07-22 18:00:57 +0200
committerGitHub <noreply@github.com>2024-07-22 18:00:57 +0200
commitccf8b2764d4a3add4a575b2c88b710b2d15ebae8 (patch)
tree80f184a9c187a585f0b5592f4fa8d1f617427ec7 /examples
parent915c5c3a870007687686e8e05fed59cdeb56be56 (diff)
Create README.md
Diffstat (limited to 'examples')
-rw-r--r--examples/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/examples/README.md b/examples/README.md
new file mode 100644
index 000000000..27072a480
--- /dev/null
+++ b/examples/README.md
@@ -0,0 +1,9 @@
+# Examples
+
+The `example` directory contains two packages:
+
+A [demo](examples/demo) illustrating the basics of Odin.
+
+It further contains [all](examples/all), which imports all [core](core) and [vendor](vendor) packages so we can conveniently run `odin check` on everything at once.
+
+For additional example code, see the [examples](https://github.com/odin-lang/examples) repository.