Initial commit

README.md

@@ -0,0 +1,32 @@
+# Iron Sea - Index Hash Map
+
+A simple hash map index for the Iron Sea toolkit.
+
+## Iron Sea: Database Toolkit
+
+**Iron Sea** provides a set of database engine bricks, which can be combined and applied on arbitrary data structures.
+
+Unlike a traditional database, it does not assume a specific physical structure for the tables nor the records, but relies on the developper to provide a set of extractor functions which are used by the specific indices provided.
+
+This enables the index implementations to be agnostic from the underlying data structure, and re-used.
+
+### Software
+
+ * Rust: https://www.rust-lang.org
+
+## Documentation
+
+For more information, please refer to the [documentation](https://epfl-dias.github.io/ironsea_index_hashmap/).
+
+If you want to build the documentation and access it locally, you can use:
+
+```sh
+cargo doc --open
+```
+
+## Acknowledgements
+
+This open source software code was developed in part or in whole in the
+Human Brain Project, funded from the European Union’s Horizon 2020
+Framework Programme for Research and Innovation under the Specific Grant
+Agreement No. 785907 (Human Brain Project SGA2).