Add README

This commit is contained in:
Jonathan Harris 2017-07-15 14:05:20 +01:00
parent fd343616ec
commit bd375981da
2 changed files with 25 additions and 0 deletions

25
README.md Normal file
View File

@ -0,0 +1,25 @@
# Habitable Zone plugin for [EDMC](https://github.com/Marginal/EDMarketConnector/wiki)
This plugin displays the "habitable-zone" (i.e. the range of distances in which you might find an Earth-Like World) when you scan the primary star in a system with a [Detailed Surface Scanner](http://elite-dangerous.wikia.com/wiki/Detailed_Surface_Scanner).
![Screenshot](img/screenie.png)
Optionally, you can choose to display the ranges in which you might find Metal-Rich, Water and/or Ammonia Worlds.
## Installation
* On EDMC's Plugins settings tab press the “Open” button. This reveals the `plugins` folder where EDMC looks for plugins.
* Download the [latest release](https://github.com/Marginal/HabZone/releases/latest).
* Open the `.zip` archive that you downloaded and move the `HabZone` folder contained inside into the `plugins` folder.
You will need to re-start EDMC for it to notice the new plugin.
## Acknowledgements
Calculations taken from Jackie Silver's [Hab-Zone Calculator](https://forums.frontier.co.uk/showthread.php?p=5452081).
## License
Copyright © 2017 Jonathan Harris.
Licensed under the [GNU Public License (GPL)](http://www.gnu.org/licenses/gpl-2.0.html) version 2 or later.

BIN
img/screenie.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB