Update Readme.

This commit is contained in:
Anna Rose 2016-01-31 15:43:55 -05:00
parent ce6851f9da
commit 2d59e17de2

View File

@ -1,29 +1,13 @@
# Tools and scripts for Elite: Dangerous
# inara.cz updater
This package provides a collection of scripts I have found useful for Elite: Dangerous.
### update_inara.py
The most useful tool here! update_inara will fetch your location and credit balance from E:D,
The inara updater will fetch your location and credit balance from E:D,
and update your inara.cz profile automatically.
### elite_info.py
elite_info fetches the user's credit balance and current location from the E:D Companion API,
and prints this information. With --dump, it will print *everything* returned by the Companion API.
### FreePIE
This directory contains scripts used with the FreePIE software. See FreePIE/Readme.md for details.
## Using the Python Scripts
## Usage
### In Windows
Download and run the latest update_inara.exe from the [releases page](https://github.com/annabunches/ed_tools/releases/latest).
Download and run the latest inara_updater.exe from the [releases page](https://github.com/annabunches/inara_updater/releases/latest).
### In Linux
@ -39,7 +23,6 @@ First, make sure you have the git submodules and the required python tools:
pip install -r requirements.txt
pip install -r elite_api/requirements.txt
Now, just run the scripts:
Now, just run the script:
./update_inara.py
./elite_info.py