diff --git a/Makefile b/Makefile index 0d3617d..c73483f 100644 --- a/Makefile +++ b/Makefile @@ -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 diff --git a/README.md b/README.md index 0b7ce4e..5d234b1 100644 --- a/README.md +++ b/README.md @@ -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. ``` ``` diff --git a/generate_docs.sh b/generate_docs.sh new file mode 100644 index 0000000..067e220 --- /dev/null +++ b/generate_docs.sh @@ -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