properly documented required packages
This commit is contained in:
parent
f2769f19ea
commit
ce5817faab
3 changed files with 35 additions and 0 deletions
16
README.md
16
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.
|
||||
|
|
|
@ -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
|
||||
|
|
3
requirements.txt
Normal file
3
requirements.txt
Normal file
|
@ -0,0 +1,3 @@
|
|||
argcomplete
|
||||
argparse
|
||||
requests
|
Loading…
Reference in a new issue