diff --git a/README.md b/README.md index fd314d7b..2620c3dc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Meshiφ (MeshiPhi) -![](logo.jpg) +![](./docs/assets/logo.jpg) ![Dev Status](https://img.shields.io/badge/Status-Active-green) [![Documentation](https://img.shields.io/badge/Manual%20-github.io%2FMeshiPhi%2F-red)](https://bas-amop.github.io/MeshiPhi/) @@ -66,19 +66,19 @@ A list of supported data sources and their associated data-loaders is given in t Samuel Hall, Harrison Abbot, Ayat Fekry, George Coombs, David Wyld, Thomas Zwagerman, Jonathan Smith, Maria Fox, and James Byrne ## Contributing -For more details on contributing, see [CONTRIBUTING.md](CONTRIBUTING.md). +For more details on contributing, see the [contributing](./CONTRIBUTING.md) guide. ## License -This software is licensed under a MIT license, but request users cite our publication. +This software is licensed under a MIT license, but request users cite our publication: -Jonathan D. Smith, Samuel Hall, George Coombs, James Byrne, Michael A. S. Thorne, J. Alexander Brearley, Derek Long, Michael Meredith, Maria Fox, (2022), Autonomous Passage Planning for a Polar Vessel, arXiv, https://arxiv.org/abs/2209.02389 +Jonathan D. Smith, Samuel Hall, George Coombs, James Byrne, Michael A. S. Thorne, J. Alexander Brearley, Derek Long, Michael Meredith, Maria Fox (2022) Autonomous Passage Planning for a Polar Vessel. _arXiv_, -For more information please see the attached ``LICENSE`` file. +For more information please see the [`LICENSE`](./LICENSE) file. ## How to Cite If you use Meshiφ in your research, please cite our software and publication: -- See the [CITATION.cff](./CITATION.cff) file for citation metadata. +- See the [`CITATION.cff`](./CITATION.cff) file for citation metadata. You can also use the "Cite this repository" button on GitHub for formatted citations. diff --git a/logo.jpg b/docs/assets/logo.jpg similarity index 100% rename from logo.jpg rename to docs/assets/logo.jpg