From ce5817faab4d10e5f177c83dc3c0ca7d2cf7ea9e Mon Sep 17 00:00:00 2001
From: alterNERDtive <nerd@alternerd.tv>
Date: Wed, 8 Jan 2020 08:30:27 +0100
Subject: [PATCH] properly documented required packages

---
 README.md        | 16 ++++++++++++++++
 generate_docs.sh | 16 ++++++++++++++++
 requirements.txt |  3 +++
 3 files changed, 35 insertions(+)
 create mode 100644 requirements.txt

diff --git a/README.md b/README.md
index 82b1d9c..00e3f95 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,16 @@
 # A collection of useful scripts around Elite Dangerous #
 
+## Requirements ##
+
+* argcomplete
+* argparse
+* requests
+* Tkinter
+
+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 ##
 
 ```
@@ -76,3 +87,8 @@ optional arguments:
   --system    output the commander’s last known system (default)
   --url       output the commander’s profile URL
 ```
+
+## Need Help / Want to Contribute? ##
+
+Just [file an issue](https://github.com/alterNERDtive/elite-scripts/issues/new)
+here or [hop into Discord](https://discord.gg/uUKFdW) if that is your thing.
diff --git a/generate_docs.sh b/generate_docs.sh
index 730ef78..fc62a6c 100644
--- a/generate_docs.sh
+++ b/generate_docs.sh
@@ -2,6 +2,17 @@
 cat > README.md << EOF
 # A collection of useful scripts around Elite Dangerous #
 
+## Requirements ##
+
+* argcomplete
+* argparse
+* requests
+* Tkinter
+
+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 ##
 
 \`\`\`
@@ -35,4 +46,9 @@ EOF
 ./explorationtools.py findcommander -h >> README.md
 cat >> README.md << EOF
 \`\`\`
+
+## Need Help / Want to Contribute? ##
+
+Just [file an issue](https://github.com/alterNERDtive/elite-scripts/issues/new)
+here or [hop into Discord](https://discord.gg/uUKFdW) if that is your thing.
 EOF
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..d1713fb
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,3 @@
+argcomplete
+argparse
+requests