From 6e8ad35fe78bf004ff361838be69da7be3d7cc7b Mon Sep 17 00:00:00 2001
From: Michal Sojka <michal.sojka@cvut.cz>
Date: Sat, 14 Sep 2024 12:17:28 +0200
Subject: [PATCH] Add initial README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2d288df
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# ros2nix
+
+Tool to convert [ROS][] `package.xml` to [Nix][] expressions
+compatible with [nix-ros-overlay][].
+
+This is work-in-progress. I'll add documentation after it works
+reasonably well.
+
+[ROS]: https://www.ros.org/
+[Nix]: https://nixos.org/
+[nix-ros-overlay]: https://github.com/lopsided98/nix-ros-overlay