ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-16 09:10:35 +03:00
Code Issues Projects Releases Wiki Activity

Home: Be explicit about OS and Python version support. 

Also some misc formatting changes, and minor text tweaks.
Athanasius 2021-05-24 10:41:56 +01:00
parent 171b5f449d
commit 16daf1d3a1
1 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Home.md

@ -18,15 +18,32 @@ currently supported by Microsoft). It will probably also function on
the following, but no testing is done on them: Windows 8,
Windows 8.1.
In general **we only support this application on OS installs, and
configurations, that are *still* supported by their vendor**.
Versions from 5.0.0 onwards do **not support Windows 7**. See
[Release 5.0.0 notes](https://github.com/EDCD/EDMarketConnector/releases/tag/Release%2F5.0.0).
You might still be able to get it to work by running from source (see below),
using Python 3.8, **but we make no guarantee that this will work, or
continue to work**.
macOS, Linux, and possibly other platforms able to run a Python 3
program, are supported by
[running from source](https://github.com/EDCD/EDMarketConnector/wiki/Running-from-source).
You can also run from source on Windows, but it will generally be easier to
use our [provided installers](https://github.com/EDCD/EDMarketConnector/releases/latest)
instead.
Once you have the application installed follow instructions on
[Installation & Setup](Installation-&-Setup.md) for your platform.
We will generally track the latest stable release of
[CPython](https://www.python.org/) ('Core Python'), but will only start
using a new Major or Minor version in our next Major or Minor release. We
will probably also avoid ".0" releases of a new Major or Minor version.
This is also contingent on [py2exe](https://github.com/py2exe/py2exe/)
supporting any new version, as we rely on that for creating the Windows
packages.
You can run the application on the same PC on which you're running
Elite Dangerous or on another PC connected via a network share of the
Game Journal files.
@ -58,7 +75,7 @@ Consoles, i.e. PS4 and Xbox, are not supported.
These are just a few of the third-party tools that have built up around
the game.
The [Elite Dangerous Community Developers](https://edcd.github.io/)
("EDCD" website lists some more, and we're sure there are others.
("EDCD") website lists some more, and we're sure there are others.
## Contributing
If you think you have a good idea for extending or improving EDMC then please read [Contributing.md](https://github.com/EDCD/EDMarketConnector/blob/main/Contributing.md).
@ -108,6 +125,7 @@ all the way into the game* then:
know this. EDMC has multi-account/commander support, and doesn't
assume it should use the last Commander.
* No 'Ship' name will be displayed.
* 'Suit' may be shown as `<Unknown>`.
* No 'System' name will be displayed.
* No 'Station' name will displayed.
* You might not be able to click the 'Update' button.
@ -123,7 +141,9 @@ filled in.
---
The user-interface is deliberately minimal - your choice of data is automatically downloaded, transmitted and/or saved when you start Elite: Dangerous, land at a station, jump to a system or scan a body.
The user-interface is deliberately minimal - your choice of data is
automatically downloaded, transmitted and/or saved when you start Elite
Dangerous, land at a station, jump to a system or scan a body.
![labelled UI image](https://github.com/EDCD/EDMarketConnector/raw/main/img/UI-annotated.png)