added README generator :)

This commit is contained in:
alterNERDtive 2019-11-12 10:31:51 +01:00
parent d714231b25
commit 77707c1d78
3 changed files with 50 additions and 3 deletions

View file

@ -1,5 +1,9 @@
all: exe
all: docs
docs:
bash generate_docs.sh
# requires a windows box
exe:
pyinstaller.exe -y edsm-getnearest.py
pyinstaller.exe -y explorationtools.py

View file

@ -36,9 +36,9 @@ subcommands:
bodycount Returns the number of bodies in a system. Will exit
with code 1 on server error and code 2 if the system
could not be found in EDSM.
distancebetween Calculates the distance between two systems. Will exit
distancebetween Calculates the distance between two systems. Will exit
with code 1 on server error and code 2 if (one of) the
systems could not be found on EDSM.
systems could not be found on EDSM.
```
```

43
generate_docs.sh Normal file
View file

@ -0,0 +1,43 @@
#!/usr/bin/env bash
cat > README.md << EOF
# A collection of useful scripts around Elite Dangerous #
## edsm-getnearest.py ##
\`\`\`
EOF
./edsm-getnearest.py -h >> README.md
cat >> README.md << EOF
\`\`\`
## explorationtools.py ##
\`\`\`
EOF
./explorationtools.py -h >> README.md
cat >> README.md << EOF
\`\`\`
\`\`\`
EOF
./explorationtools.py bodycount -h >> README.md
cat >> README.md << EOF
\`\`\`
\`\`\`
EOF
./explorationtools.py distancebetween -h >> README.md
cat >> README.md << EOF
\`\`\`
EOF