From 2a536f88f18357490f0fe423a0b562100061f2c7 Mon Sep 17 00:00:00 2001
From: Ivan <vnmsklnk@yandex.ru>
Date: Sun, 5 Nov 2023 16:18:57 +0300
Subject: [PATCH] added README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..12bd52a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# aero-vloc
+aero-vloc is a tool for UAVs localization using different VPR systems and feature matchers.
+VPR systems AnyLoc, CosPlace, EigenPlaces, MixVPR, NetVLAD are now supported as well as LightGlue and SuperGlue keypoint matchers.
+
+## Weights
+Weights for MixVPR, NetVLAD and SuperGlue as well as cluster centers for AnyLoc can be downloaded [here](https://drive.google.com/file/d/1JJWjbaY59XNICiXfQYdwoTYC6pIbzc_4/view?usp=sharing).
+All other necessary files for CosPlace, EigenPlaces and SuperPoint will be downloaded automatically via TorchHub.
+
+## Usage
+Please check `example.ipynb` for an example of localizing and using the Recall metric.
\ No newline at end of file