Skip to content

Commit a942fd0

Browse files
authored
Merge pull request #920 from EnergySystemsModellingLab/update-readme-post-release
Update README to signpost release pages
2 parents 043b52f + 7d74258 commit a942fd0

1 file changed

Lines changed: 18 additions & 2 deletions

File tree

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
<!-- ALL-CONTRIBUTORS-BADGE:END -->
55
[![Build and test](https://github.com/EnergySystemsModellingLab/MUSE2/actions/workflows/cargo-test.yml/badge.svg)](https://github.com/EnergySystemsModellingLab/MUSE2/actions/workflows/cargo-test.yml)
66
[![codecov](https://codecov.io/github/EnergySystemsModellingLab/MUSE2/graph/badge.svg?token=nV8gp1NCh8)](https://codecov.io/github/EnergySystemsModellingLab/MUSE2)
7+
[![Crates.io Version](https://img.shields.io/crates/v/muse2)](https://crates.io/crates/muse2)
8+
[![DOI](https://zenodo.org/badge/790809493.svg)](https://doi.org/10.5281/zenodo.17350372)
79
[![GitHub](https://img.shields.io/github/license/EnergySystemsModellingLab/MUSE2)](https://raw.githubusercontent.com/EnergySystemsModellingLab/MUSE2/main/LICENSE)
810

911
# MUSE2
@@ -45,11 +47,25 @@ foresight over the whole modelled time horizon.
4547

4648
## Getting started
4749

48-
To start using MUSE2, please refer to [the documentation]. If you wish to develop MUSE2 or
49-
build it from source, please see [the developer guide].
50+
The easiest way to install MUSE2 is to download the latest version for your platform on [our
51+
releases page]. For information on getting started, please consult [the documentation].
5052

53+
If you wish to develop MUSE2 or build it from source, please see [the developer guide].
54+
55+
You can also install the [`muse2` crate from crates.io][muse2-crate], though this installation
56+
method is only recommended for developers.
57+
58+
[our releases page]: https://github.com/EnergySystemsModellingLab/MUSE2/releases
5159
[the documentation]: https://energysystemsmodellinglab.github.io/MUSE2/introduction.html
5260
[the developer guide]: https://energysystemsmodellinglab.github.io/MUSE2/developer_guide.html
61+
[muse2-crate]: https://crates.io/crates/muse2
62+
63+
## Citing this repository
64+
65+
If you use MUSE2 in your work, please cite us. For information on how to cite this repository, see
66+
[the Zenodo page for the latest release][zenodo-page].
67+
68+
[zenodo-page]: https://doi.org/10.5281/zenodo.17350372
5369

5470
## Contributors ✨
5571

0 commit comments

Comments
 (0)