mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-14 08:17:13 +03:00

Athanasius 344351b1fa README.md: Minor formatting edits

* Move 'Running from source' to just after installation.
 * Consistently use '---' headings.
 * Shorten heading markdown to --- or ===

2020-07-06 17:32:11 +01:00

2.4 KiB

Raw Blame History

Any questions or offers of help can be directed to the EDCD Discord #edmc channel:

Elite: Dangerous Market Connector (EDMC)

This application is only of use to PC players of the game Elite Dangerous (and its expansions). It won't work with PS4 or Xbox accounts.

It utilises the Journal files written by the game on the user's computer, together with data from the API Frontier Developments supplies in order to feed this data to various third party sites that the user may find useful.

See the Wiki documenation for more details.

Installation & Uninstall

Please see the Installation & Setup wiki page.

Running from source

Please see the Running from source wiki page.

Plugins

Plugins extend the behaviour of this app. See the Plugins wiki page for more information.

If you would like to write a plugin please see PLUGINS.md.

Troubleshooting

Please see the Troubleshooting wiki page.

Reporting a problem

Please report a problem as a new GitHub issue. Please wait for the error to occur and zip up and attach this app's log file to the new issue:

Mac:

$TMPDIR/EDMarketConnector.log

Windows:

%TMP%\EDMarketConnector.log

Packaging for distribution

Please see docs/Releasing.md.

Disclaimer

This app uses the “Companion” web API that Frontier originally supplied for their Elite Dangerous iOS app and now support for third-party apps. However this API could go away at some time in the future - in which case this app will cease to work.

Acknowledgements

Please see the Acknowledgements wiki page.

License

Licensed under the GNU Public License (GPL) version 2 or later.

2.4 KiB Raw Blame History