summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRangi <remy.oukaour+rangi42@gmail.com>2021-09-02 18:48:17 -0400
committerRangi <remy.oukaour+rangi42@gmail.com>2021-09-02 18:48:17 -0400
commit868e28f309ec8d08bcdea913c3fc53b0ef55315f (patch)
tree5e5d9a60fe1859960193ba166d09006c9cc4cc81
parent021702628c984294247e2a592fa107f5d8e3288a (diff)
Update usage doc comments for some tools/*.py scripts
-rwxr-xr-xtools/palfix.py8
-rwxr-xr-xtools/sym_comments.py2
-rwxr-xr-xtools/toc.py1
3 files changed, 10 insertions, 1 deletions
diff --git a/tools/palfix.py b/tools/palfix.py
index 20c9ef29c..8d53d35e7 100755
--- a/tools/palfix.py
+++ b/tools/palfix.py
@@ -1,6 +1,14 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
+"""
+Usage: python palfix.py image.png
+
+Fix the palette format of the input image. Colored images (Pokémon or trainer
+sprites) will become indexed, with a palette sorted {white, light color, dark
+color, black}. Grayscale images will become two-bit grayscale.
+"""
+
from __future__ import print_function
import sys
diff --git a/tools/sym_comments.py b/tools/sym_comments.py
index b26a81b7f..27d37ca23 100755
--- a/tools/sym_comments.py
+++ b/tools/sym_comments.py
@@ -2,7 +2,7 @@
# -*- coding: utf-8 -*-
"""
-Usage: ./sym_comments.py file.asm [pokecrystal.sym] > file_commented.asm
+Usage: python3 sym_comments.py file.asm [pokecrystal.sym] > file_commented.asm
Comments each label in file.asm with its bank:address from the sym file.
"""
diff --git a/tools/toc.py b/tools/toc.py
index 13b75ae1c..e3d719edf 100755
--- a/tools/toc.py
+++ b/tools/toc.py
@@ -3,6 +3,7 @@
"""
Usage: python3 toc.py [-n] files.md...
+
Replace a "## TOC" heading in a Markdown file with a table of contents,
generated from the other headings in the file. Supports multiple files.
Headings must start with "##" signs to be detected.