From 82b57420a925283b0c38b5b71773661a25d5a94c Mon Sep 17 00:00:00 2001
From: copygirl <copygirl@mcft.net>
Date: Mon, 4 Sep 2023 16:04:32 +0200
Subject: [PATCH] Add a basic README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7144cf9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+# flecs-zig-ble
+
+.. is a [Zig] wrapper around [Flecs], the powerful and fast Entity Component System library. It provides higher-level abstractions around Flecs' primitives and uses Zig's meta-programming functionality for more easily readable and maintainable code.
+
+This library is still very much work-in-progress and not ready for use. It's available for people to have a look, give feedback and take inspirations. I'm attempting to develop this project using a test-driven development approach, translating Flecs' C tests (and later, examples) to Zig, creating wrapper types and functions as I go.
+
+[Zig]: https://ziglang.org/
+[Flecs]: https://github.com/SanderMertens/flecs