From 61f6051c206b6e9eb55043b3c99b87530d0eaf2c Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Wed, 8 Jan 2020 15:13:10 +0100 Subject: [PATCH] updated README --- README.md | 15 +++++++++++++-- generate_docs.sh | 15 +++++++++++++-- 2 files changed, 26 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e99211c..2c560bb 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,18 @@ You probably want to install your distribution/OS package for Tkinter instead of using pip. Then do the good old `pip install --user -r requirements.txt` or `pip3 install --user -r requirements.txt`. -## edsm-getnearest.py ## +## Pre-Compiled Version (Windows) ## + +If you check the +[releases](https://github.com/alterNERDtive/elite-scripts/releases) you’ll find +a .zip file with pre-compiled scripts that don’t need Python installed. Mostly +a) for saving myself some hassle and b) because that’s easier to distribute with +my +[VoiceAttack profiles](https://github.com/alterNERDtive/VoiceAttack-profiles). + +## Scripts ## + +### edsm-getnearest.py ### ``` usage: edsm-getnearest.py [-h] --system SYSTEM [--short] [--gui | --text] @@ -31,7 +42,7 @@ optional arguments: --text explicitly give text output ``` -## explorationtools.py ## +### explorationtools.py ### ``` usage: explorationtools.py [-h] diff --git a/generate_docs.sh b/generate_docs.sh index 727973f..76e148c 100644 --- a/generate_docs.sh +++ b/generate_docs.sh @@ -13,7 +13,18 @@ You probably want to install your distribution/OS package for Tkinter instead of using pip. Then do the good old \`pip install --user -r requirements.txt\` or \`pip3 install --user -r requirements.txt\`. -## edsm-getnearest.py ## +## Pre-Compiled Version (Windows) ## + +If you check the +[releases](https://github.com/alterNERDtive/elite-scripts/releases) you’ll find +a .zip file with pre-compiled scripts that don’t need Python installed. Mostly +a) for saving myself some hassle and b) because that’s easier to distribute with +my +[VoiceAttack profiles](https://github.com/alterNERDtive/VoiceAttack-profiles). + +## Scripts ## + +### edsm-getnearest.py ### \`\`\` EOF @@ -21,7 +32,7 @@ EOF cat >> README.md << EOF \`\`\` -## explorationtools.py ## +### explorationtools.py ### \`\`\` EOF