- repository goes online

LICENSE

@@ -0,0 +1,40 @@
+Copyright (c) 2022, Martin F. Schiffner
+All rights reserved.
+
+This is citationware.
+
+Redistribution and use in source and binary forms,
+with or without modification, are permitted provided that
+the following conditions are met:
+
+* Redistributions of source code must retain
+  the above copyright notice, this list of conditions, and
+  the following disclaimer.
+
+* Redistributions in binary form must reproduce
+  the above copyright notice, this list of conditions, and
+  the following disclaimer in
+  the documentation and/or other materials provided with the distribution.
+
+* The name of the author must not be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+* All publications of results obtained with this software or its modifications must cite
+  this GitHub repository and the scientific paper
+
+  [1] M. F. Schiffner,
+      "Rhombic grids reduce the number of voxels in fast pulse-echo ultrasound imaging,"
+      2022 IEEE Int. Ultrasonics Symp. (IUS), Venice, Italy, Oct. 2022, pp. 1–4.
+      arxiv: https://arxiv.org/abs/2210.04818
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1 +1,32 @@
-# rhombic_grids
+# Rhombic Grids for Coherent Plane-Wave Compounding
+
+<!-- shields -->
+[![GitHub][license-shield]][license-url]
+![GitHub repo size][size-shield]
+![GitHub Downloads][downloads-shield]
+![Stargazers][stars-shield]
+[![Watch on YouTube](https://img.shields.io/youtube/views/T6dkazW5ZuM?label=YouTube)](https://www.youtube.com/watch?v=T6dkazW5ZuM)
+
+[license-shield]: https://img.shields.io/github/license/mschiffn/rhombic_grids
+[license-url]: https://github.com/mschiffn/rhombic_grids/COPYING
+[size-shield]: https://img.shields.io/github/repo-size/mschiffn/rhombic_grids
+[downloads-shield]: https://img.shields.io/github/downloads/mschiffn/rhombic_grids/total
+[stars-shield]: https://img.shields.io/github/stars/mschiffn/rhombic_grids.svg
+
+<!-- content -->
+Simple
+[MATLAB](https://mathworks.com/products/matlab.html) implementation of
+the rhombic grid
+[[1]](#SchiffnerIUS2022) for
+coherent plane-wave compounding.
+
+## Coming soon... stay tuned!
+
+## References :notebook:
+
+1. <a name="SchiffnerIUS2022"></a>
+M. F. Schiffner,
+"Rhombic grids reduce the number of voxels in fast pulse-echo ultrasound imaging,"
+2022 IEEE Int. Ultrasonics Symp. (IUS), Venice, Italy, Oct. 2022, pp. 1–4.
+[![arXiv](https://img.shields.io/badge/arXiv-2210.04818-b31b1b.svg)](https://arxiv.org/abs/2210.04818)
+[![Watch on YouTube](https://img.shields.io/youtube/views/T6dkazW5ZuM?label=YouTube)](https://www.youtube.com/watch?v=T6dkazW5ZuM)